stable-baselines3/docs
Paul Stahlhofen c5c29a32d9
Clarify the use of Gym wrappers with make_vec_env (#2079)
* Added a note to the documentation of Vectorized Environments to show the
possibility of wrapping sub-environments with `make_vec_env` (See #2075 )

* Add example

---------

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2025-02-07 12:04:48 +01:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Documentation update (#1732) 2023-11-03 17:17:46 +01:00
guide Clarify the use of Gym wrappers with make_vec_env (#2079) 2025-02-07 12:04:48 +01:00
misc Clarify the use of Gym wrappers with make_vec_env (#2079) 2025-02-07 12:04:48 +01:00
modules Add policy documentation links to policy_kwargs parameter (#2050) 2024-12-02 14:40:05 +01:00
conda_env.yml Drop python 3.8 and add python 3.12 support (#2041) 2024-11-18 15:40:36 +01:00
conf.py Drop python 3.8 and add python 3.12 support (#2041) 2024-11-18 15:40:36 +01:00
index.rst Drop python 3.8 and add python 3.12 support (#2041) 2024-11-18 15:40:36 +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 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