mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-05-17 21:20:11 +00:00
* Add package to install * Update docs packages installation command Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
25 lines
387 B
Markdown
25 lines
387 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
|
|
```
|