DOC: Add dedicated developers guide section

ARM-DOE · Aug 1, 2023 · a5fc615 · a5fc615
1 parent 7667557
commit a5fc615
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 6 deletions.
diff --git a/doc/environment.yml b/doc/environment.yml
@@ -32,6 +32,7 @@ dependencies:
   - sphinx-design
   - sphinx-copybutton
   - nbsphinx
+  - pre_commit
   - pip
   - pip:
       - pooch

diff --git a/doc/source/dev/CONTRIBUTING.rst b/doc/source/dev/CONTRIBUTING.rst
@@ -0,0 +1 @@
+.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
@@ -0,0 +1,23 @@
+=================
+Developer's Guide
+=================
+
+.. toctree::
+   :maxdepth: 3
+   :hidden:
+
+   CONTRIBUTING
+
+This discusses information relevant to developing Py-ART.
+
+--------
+Versions
+--------
+Py-ART follows `semantic versioning <https://semver.org>`_ in its version number. This means
+that any Py-ART ``1.x`` release will be backwards compatible with an earlier ``1.y`` release. By
+"backward compatible", we mean that **correct** code that works on a ``1.y`` version will work
+on a future ``1.x`` version. It's always possible for bug fixes to change behavior or make
+incorrect code cease to work. Backwards-incompatible changes will only be allowed when changing
+to version ``2.0``. Such changes will be proceeded by `FutureWarning` as appropriate.
+For a version ``1.x.y``, we change ``x`` when we release new features, and ``y``
+when we make a release with only bug fixes.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -12,23 +12,23 @@ The Python ARM Radar Toolkit - Py-ART
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: Reference Guide
+   :caption: Example Gallery
 
-   API/index.rst
+   examples/index.rst
 
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: Developer's Guide
+   :caption: Reference Guide
 
-   dev/index.rst
+   API/index.rst
 
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: Example Gallery
+   :caption: Developer's Guide
 
-   examples/index.rst
+   dev/index.rst
 
 .. toctree::
    :maxdepth: 2