stable-baselines3/docs/README.md
Stefan Schneider 5abd50a853
Docs: Add mobile-env to community projects (#1617)
* Docs: Add mobile-env to community projects

* Update docs Readme with correct install command

Without the quotes, I get `no matches found: .[docs]`

* Add changelog entry for adding mobile-env

* Fix format in projects.rst

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>

---------

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2023-07-21 16:33:01 +02:00

25 lines
389 B
Markdown

## Stable Baselines3 Documentation
This folder contains documentation for the RL baselines.
### Build the Documentation
#### Install Sphinx and Theme
Execute this command in the project root:
```
pip install -e ".[docs]"
```
#### Building the Docs
In the `docs/` folder:
```
make html
```
if you want to building each time a file is changed:
```
sphinx-autobuild . _build/html
```