gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-02 14:26:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation build tooling (#700)

Browse Source 
Co-authored-by: Martin van Hensbergen <martin@mvhensbergen.com>
This commit is contained in:
mvhensbergen
2023-09-05 11:32:10 +02:00
committed by GitHub
parent 74e6e13b78
commit 83db5c2b26
2 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/README.md
View File

@@ -47,9 +47,11 @@ To rebuild the documentation automatically every time a change is made:
```
cd docs
sphinx-autobuild -b dirhtml . _build
sphinx-autobuild -b dirhtml --watch ../gymnasium --re-ignore "pickle$" . _build
```
You can then open http://localhost:8000 in your browser to watch a live updated version of the documentation.
## Writing Tutorials
We use Sphinx-Gallery to build the tutorials inside the `docs/tutorials` directory. Check `docs/tutorials/demo.py` to see an example of a tutorial and [Sphinx-Gallery documentation](https://sphinx-gallery.github.io/stable/syntax.html) for more information.