diff --git a/doc/environment.yml b/doc/environment.yml index 1080ca48f3..009e2ca6be 100644 --- 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 new file mode 100644 index 0000000000..b1cd2f37dc --- /dev/null +++ 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 new file mode 100644 index 0000000000..9c88b29ff4 --- /dev/null +++ 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 `_ 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 index ca4816e015..257014053e 100644 --- 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