stable-baselines3/docs/README.md

26 lines
389 B
Markdown
Raw Permalink Normal View History

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