SciPost Code Repository

Skip to content
Snippets Groups Projects
Commit 5cbbd926 authored by Mathijs de Bruin's avatar Mathijs de Bruin
Browse files

Document documentation practises.

parent 87b8f6c6
No related branches found
No related tags found
No related merge requests found
...@@ -110,3 +110,18 @@ can use them. ...@@ -110,3 +110,18 @@ can use them.
(scipostenv) $ ./manage.py makemigration (scipostenv) $ ./manage.py makemigration
(scipostenv) $ ./manage.py migrate (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`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment