docs: Add documentation on local docs generation
Signed-off-by: Fabian P. Schmidt <kerel@mailbox.org>merge-requests/390/head
parent
1dfdbc8cc3
commit
203f9a7258
|
@ -71,6 +71,18 @@ To add new or remove existing third-party static assets:
|
||||||
$ ./node_modules/.bin/gulp 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
|
Coding Style
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue