Skip to content

Commit

Permalink
docs(doc): add README with the instructions on how to build the html …
Browse files Browse the repository at this point in the history
…documentation
  • Loading branch information
gilrrei committed Jan 17, 2025
1 parent 9d00305 commit 7137b8f
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions doc/README.md
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`

0 comments on commit 7137b8f

Please sign in to comment.