mirror of
https://github.com/bellingcat/cisticola.git
synced 2026-06-11 12:58:33 +03:00
added table diagram, and brief developer guide and deployment info for docs
This commit is contained in:
23
docs/source/developer_guide.rst
Normal file
23
docs/source/developer_guide.rst
Normal 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.
|
||||
Reference in New Issue
Block a user