aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJocelynDelalande <JocelynDelalande@users.noreply.github.com>2017-08-24 17:00:58 +0200
committerAlexis Metaireau <alexis@notmyidea.org>2017-08-24 17:00:58 +0200
commitee1ecbf3e747daa711744a05027a667a302cc7e9 (patch)
tree1a7fa99cc7b481b0cd0ada8cad16c77a4e746ebb /docs
parent2ec4fb589fdc0fa14297263fd9357c796689dee9 (diff)
downloadihatemoney-mirror-ee1ecbf3e747daa711744a05027a667a302cc7e9.zip
ihatemoney-mirror-ee1ecbf3e747daa711744a05027a667a302cc7e9.tar.gz
ihatemoney-mirror-ee1ecbf3e747daa711744a05027a667a302cc7e9.tar.bz2
Add doc building instructions (#263)
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst16
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?
===============