added table diagram, and brief developer guide and deployment info for docs

This commit is contained in:
Tristan Lee
2023-08-03 23:58:12 -05:00
parent d3b8e1a3b3
commit ef9292bc90
9 changed files with 1446 additions and 46 deletions

View File

@@ -0,0 +1,23 @@
Developer Guide
===============
Installation
------------
To install the necessary dependencies for building the documentation and running unit tests, run the following command from the package root directory:
.. code-block::
pipenv install --dev
Documentation
-------------
If changes are made to the package structure or additional modules are created, you can update the Sphinx source ``cisticola.*.rst`` files by running the following command from the ``docs/`` directory:
.. code-block::
pipenv run make apidoc
Formatting
----------
Cisticola uses `black <https://github.com/psf/black>`_ to format source code.