Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ pip3 install -r requirements.txt
### Build the Docs
Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.

To automate the build process, you can use a [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild) package. \
Run this command from the virtual environment to build the documentation and start a server:

```bash
sphinx-autobuild . ./_build/html
```
For more options for the command, see the documentation linked above.

Now you can access the page using the local address: http://127.0.0.1:8000. \
After saving any changes, the documentation will be automatically rebuilt and displayed.

Any images, diagrams, or videos are subject to their own copyrights, trademarks, and licenses.

Want a local PDF version? Follow the [instructions here](https://gist.github.com/alfredodeza/7fb5c667addb1c6963b9).
Loading