stable-baselines3/docs
Ashish Dutt 954daaac37
Custom environment page modified. Following fixes are committed in response to issue#755. (#758)
* Page modified. Following fixes are committed in response to issue#755.

- fixed the broken url on creating custom gym environment. Also added appropriate advice by citing official OpenAi gym documents.
- SB3 text tweaked.

* modified page

- updated the in-line text hyperlinks to follow Sphinx restructured text format.

* modified page

- updated the in-line text hyperlinks to follow Sphinx restructured text format.
- updated text grammar

* Language

Co-authored-by: Anssi <kaneran21@hotmail.com>
2022-02-05 13:36:36 +02:00
..
_static Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +01:00
common Fix logger setup (#469) 2021-06-14 15:17:48 +02:00
guide Custom environment page modified. Following fixes are committed in response to issue#755. (#758) 2022-02-05 13:36:36 +02:00
misc HumanOutputFormat: make length configurable, throw error if keys alias (#756) 2022-02-05 12:57:35 +02:00
modules Gym fixes - Follow up from #705 (#734) 2022-02-04 15:13:57 -08:00
conda_env.yml Drop Python 3.6 support (#685) 2021-12-06 12:54:43 +01:00
conf.py Update docs (custom policy, type hints) (#167) 2020-09-29 20:41:14 +03:00
index.rst Update SB3 Contrib doc (ARS) and W&B integration (#726) 2022-01-18 15:10:25 +01: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 Add package to install (#378) 2021-04-10 14:04:37 +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