diff options
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index d2bdbcc..0415387 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -99,6 +99,22 @@ update the issue tracker with your feedback. Thanks again! +How to build the documentation ? +===================================== + +The documentation is using `sphinx <http://www.sphinx-doc.org/en/stable/>`_ and +its source is located inside the `docs folder +<https://github.com/spiral-project/ihatemoney/tree/master/docs>`_. + +Install doc dependencies (within the virtualenv, if any):: + + pip install -r docs/requirements.txt + +And to produce html doc in `docs/_output` folder:: + + cd docs/ + make html + How to release? =============== |