From a5ed16849c32881ccf7254011198753fad1c20ed Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Fri, 18 Nov 2022 19:18:08 -0800 Subject: [PATCH] Documentation --- docs/source/dev/contributing.rst | 7 +++++++ docs/source/index.rst | 2 ++ 2 files changed, 9 insertions(+) create mode 100644 docs/source/dev/contributing.rst diff --git a/docs/source/dev/contributing.rst b/docs/source/dev/contributing.rst new file mode 100644 index 0000000..6ba3e7f --- /dev/null +++ b/docs/source/dev/contributing.rst @@ -0,0 +1,7 @@ +Contributing +============ + +Testing +------- + +Before submitting PRs or patches, please make sure your branch passes all of the unit tests by running Pytest. diff --git a/docs/source/index.rst b/docs/source/index.rst index 94e6563..38e805f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -25,6 +25,7 @@ exports into JSON documents for processing by other applications. :maxdepth: 2 :caption: Developer Documentation + dev/contributing dev/modules dev/classes @@ -32,5 +33,6 @@ exports into JSON documents for processing by other applications. Indices and tables ================== +* :ref:`modindex` * :ref:`genindex` * :ref:`search`