From 203f9a72581537d7ebf1acdea4a9385584ca6419 Mon Sep 17 00:00:00 2001 From: "Fabian P. Schmidt" Date: Mon, 8 Jul 2019 16:04:35 +0200 Subject: [PATCH] docs: Add documentation on local docs generation Signed-off-by: Fabian P. Schmidt --- docs/developer-guide.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 70a15af..3ec7360 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -71,6 +71,18 @@ To add new or remove existing third-party static assets: $ ./node_modules/.bin/gulp assets +Documentation +------------- + +The documentation can be generated locally with sphinx:: + + $ cd docs + $ virtualenv -p python3 env + $ source env/bin/activate + $ pip install sphinx_rtd_theme + $ make html SPHINXOPTS="-W" + + Coding Style ------------