Skip to content
Snippets Groups Projects
Commit 7d7bf2ea authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Explain better how to build the docs

parent 9a187bb0
No related branches found
No related tags found
2 merge requests!148F fix jsdoc,!147Release 0.15.1
Pipeline #59136 passed
......@@ -80,13 +80,16 @@ See `build.properties.d/00_default.properties` for more information.
## Build the documentation #
Build documentation in `build/` with `make doc`.
Install the below requirements and build documentation in `build/`
with `make doc`. You may need to set the environment variables used in
`src/doc/Makefile`, especially `JSDOC_BIN` in case you didn't install
jsdoc globally.
### Requirements ##
- sphinx
- sphinx-autoapi
- jsdoc (`npm install jsdoc`)
- jsdoc-sphinx (`npm install jsdoc-sphinx`)
- @indiscale/jsdoc-sphinx (`npm install @indiscale/jsdoc-sphinx`)
- sphinx-js
- recommonmark
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment