From 5cbbd926de83276d86655c063db6e76a545d3b1b Mon Sep 17 00:00:00 2001 From: Mathijs de Bruin <mathijs@mathijsfietst.nl> Date: Sun, 18 Dec 2016 21:43:55 +0100 Subject: [PATCH] Document documentation practises. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 4622ae3ae..c3e44c8d7 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,18 @@ can use them. (scipostenv) $ ./manage.py makemigration (scipostenv) $ ./manage.py migrate ``` + +## Documentation +Project documentation can be found in `docs` and can be rendered using +[Sphinx](http://www.sphinx-doc.org/). Note that rendering documentation is only +available from the virtual environment - and only when the host settings have +been configured. + +To build the documentation, run: + +```shell +(scipostenv) $ cd docs +(scipostenv) $ make html +``` + +After this, generated documentation should be available in `docs/_build/html`. -- GitLab