Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add dedicated developers guide section #1442

Merged
merged 1 commit into from
Aug 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ dependencies:
- sphinx-design
- sphinx-copybutton
- nbsphinx
- pre_commit
- pip
- pip:
- pooch
Expand Down
1 change: 1 addition & 0 deletions doc/source/dev/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../CONTRIBUTING.rst
23 changes: 23 additions & 0 deletions doc/source/dev/index.rst
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 6 additions & 6 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down