stable-baselines3/docs
Quentin Gallouédec abffa16198
Mypy type checking (#1143)
* Install and configure mypy

* Test if github CI uses setup.cfg for mypy

* force color output

* tab to space

* Try to fix regex

* follow_imports silent

* use space as indentation

* fix indentation setup.cfg

* Show error code

* Update doc

* Udate changelog

* Ignore mypy cache files from commit

* Update gitlab CI

* Add pytype and mypy entry in Makefile

* Make mypy happy

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2022-11-16 13:22:57 +01:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Add explanation of logger output (#803) 2022-03-07 12:20:43 +01:00
guide Fix typo in documentation (#1177) 2022-11-15 15:00:03 +01:00
misc Mypy type checking (#1143) 2022-11-16 13:22:57 +01:00
modules Standardized the use of `"` for string representation (#1086) 2022-10-03 15:15:39 +02:00
conda_env.yml Release v1.6.0 (#958) 2022-07-12 22:50:23 +02:00
conf.py Mypy type checking (#1143) 2022-11-16 13:22:57 +01: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