stable-baselines3/docs
Kyle Sayers fab6cb339d
BitFlippingEnv argument check and docs clarification (#1698)
* made change, not tested yet

* add back _obs_space with note on purpose

* match formatting

* update documentation
2023-09-27 10:18:30 +02:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Add stats window argument (#1424) 2023-04-05 11:33:26 +02:00
guide Fix type hints for callbacks, utils and VecTranspose (#1648) 2023-08-29 16:04:08 +02:00
misc BitFlippingEnv argument check and docs clarification (#1698) 2023-09-27 10:18:30 +02:00
modules Update outdated custom env doc (#1490) 2023-05-08 13:48:26 +02:00
conda_env.yml Drop python 3.7, add 3.11 and update github templates (#1587) 2023-07-03 12:44:18 +02:00
conf.py Fix read the doc default theme (#1668) 2023-09-07 09:53:05 +02:00
index.rst Doc fix and add Stable-Baselines3 Jax (SBX) page (#1566) 2023-06-21 18:54:16 +02:00
make.bat Add doc 2019-09-26 11:46:40 +02:00
Makefile Dictionary Observations (#243) 2021-05-11 12:29:30 +02:00
README.md Docs: Add mobile-env to community projects (#1617) 2023-07-21 16:33:01 +02:00
spelling_wordlist.txt Add custom objects support + bug fix (#336) 2021-03-06 15:17:43 +02:00

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