saymrwulf/stable-baselines3
1
0
Fork 0
mirror of https://github.com/saymrwulf/stable-baselines3.git synced 2026-06-10 00:39:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
stable-baselines3/docs
History
Antonin RAFFIN dd3d0acf15
Update readme and clarify planned features (#2030) 
* Update readme and clarify planned features

* Fix rtd python version

* Fix pip version for rtd

* Update rtd ubuntu and mambaforge

* Add upper bound for gymnasium

* [ci skip] Update readme
2024-10-29 12:23:13 +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 Update readme and clarify planned features (#2030) 2024-10-29 12:23:13 +01:00
misc Update readme and clarify planned features (#2030) 2024-10-29 12:23:13 +01:00
modules Add warning when using PPO on GPU and update doc (#2017) 2024-10-07 11:24:47 +02:00
conda_env.yml Update readme and clarify planned features (#2030) 2024-10-29 12:23:13 +01:00
conf.py Update dependencies (remove sphinx type hint plugin), protect type aliases 2023-10-23 20:14:15 +02:00
index.rst Update readme and clarify planned features (#2030) 2024-10-29 12:23:13 +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

README.md

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