-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(doc): add README with the instructions on how to build the html …
…documentation
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# HTML documentation | ||
|
||
QUEENS uses [Sphinx](https://www.sphinx-doc.org/en/master/) to automatically build an html-documentation from the docstrings. | ||
|
||
## Build the documentation | ||
|
||
When building the documentation on your machine for the first time or after adding new modules or classes to QUEENS, one needs to first rebuild the `autodoc index` by running: | ||
|
||
```bash | ||
cd <queens-base-directory> | ||
sphinx-apidoc -o doc/source queens -f -M | ||
``` | ||
|
||
To actually build the html-documentation, navigate into the doc folder and run the make command: | ||
|
||
```bash | ||
cd doc | ||
sphinx-build -b html -d build/doctrees source build/html | ||
``` | ||
|
||
You can now view the documentation in your favorite browser by opening `build/html/index.html` |