From ee1ecbf3e747daa711744a05027a667a302cc7e9 Mon Sep 17 00:00:00 2001 From: JocelynDelalande Date: Thu, 24 Aug 2017 17:00:58 +0200 Subject: [PATCH] Add doc building instructions (#263) --- docs/contributing.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index d2bdbcca..04153877 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 `_ and +its source is located inside the `docs folder +`_. + +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? ===============