Skip to content

Commit 518e1ea

Browse files
authored
Add instruction for sphinx-autobuild #855
Add instruction for sphinx-autobuild
2 parents 22e48bc + 4f489b2 commit 518e1ea

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ pip3 install -r requirements.txt
3333
### Build the Docs
3434
Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.
3535

36+
To automate the build process, you can use a [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild) package. \
37+
Run this command from the virtual environment to build the documentation and start a server:
38+
39+
```bash
40+
sphinx-autobuild . ./_build/html
41+
```
42+
For more options for the command, see the documentation linked above.
43+
44+
Now you can access the page using the local address: http://127.0.0.1:8000. \
45+
After saving any changes, the documentation will be automatically rebuilt and displayed.
46+
3647
Any images, diagrams, or videos are subject to their own copyrights, trademarks, and licenses.
3748

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

0 commit comments

Comments
 (0)