Switch to Markdown documentation (MyST parser)#508
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the Sphinx documentation from reStructuredText to Markdown using the MyST parser, updating the docs build configuration accordingly, and bumps the minimum stable-baselines3 version in requirements.txt.
Changes:
- Enable MyST Markdown support in Sphinx (
myst_parser,.mdsource suffixes, MyST extensions/config). - Convert guide and API docs pages from
.rstto.md(with MyST anchors andeval-rstblocks where needed), and replace the changelog page with a Markdown/include-based version. - Update
requirements.txtto require a newerstable-baselines3alpha.
Reviewed changes
Copilot reviewed 29 out of 30 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| requirements.txt | Bumps minimum stable-baselines3 version requirement. |
| docs/modules/wrappers.md | Switches module docs page to MyST Markdown with eval-rst automodule. |
| docs/modules/utils.md | Switches module docs page to MyST Markdown with eval-rst automodule. |
| docs/modules/exp_manager.md | Switches module docs page to MyST Markdown and wraps directives in eval-rst. |
| docs/modules/callbacks.md | Switches module docs page to MyST Markdown with eval-rst automodule. |
| docs/misc/changelog.rst | Removes old RST changelog stub page. |
| docs/misc/changelog.md | Adds MyST Markdown changelog page including the root CHANGELOG.md. |
| docs/guide/tuning.rst | Removes old RST tuning guide page (converted to Markdown). |
| docs/guide/tuning.md | Adds MyST Markdown tuning guide page. |
| docs/guide/train.rst | Removes old RST training guide page (converted to Markdown). |
| docs/guide/train.md | Adds MyST Markdown training guide page. |
| docs/guide/sbx.rst | Removes old RST SBX guide page (converted to Markdown). |
| docs/guide/sbx.md | Adds MyST Markdown SBX guide page. |
| docs/guide/quickstart.rst | Removes old RST quickstart page (converted to Markdown). |
| docs/guide/quickstart.md | Adds MyST Markdown quickstart page (with MyST substitutions/front matter). |
| docs/guide/plot.rst | Removes old RST plotting guide page (converted to Markdown). |
| docs/guide/plot.md | Adds MyST Markdown plotting guide page. |
| docs/guide/integrations.rst | Removes old RST integrations page (converted to Markdown). |
| docs/guide/integrations.md | Adds MyST Markdown integrations page. |
| docs/guide/install.rst | Removes old RST install page (converted to Markdown). |
| docs/guide/install.md | Adds MyST Markdown install page. |
| docs/guide/enjoy.rst | Removes old RST enjoy page (converted to Markdown). |
| docs/guide/enjoy.md | Adds MyST Markdown enjoy page. |
| docs/guide/custom_env.rst | Removes old RST custom env page (converted to Markdown). |
| docs/guide/custom_env.md | Adds MyST Markdown custom env page. |
| docs/guide/config.rst | Removes old RST config page (converted to Markdown). |
| docs/guide/config.md | Adds MyST Markdown config page. |
| docs/conf.py | Enables myst_parser, allows .md sources, and configures MyST extensions/anchors. |
| docs/conda_env.yml | Adds myst-parser to the RTD conda environment. |
| CHANGELOG.md | Notes the documentation migration to Markdown/MyST. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
araffin
commented
Mar 13, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Same as DLR-RM/stable-baselines3#2219
Motivation and Context
Types of changes
Checklist:
make format(required)make check-codestyleandmake lint(required)make pytestandmake typeboth pass. (required)Note: we are using a maximum length of 127 characters per line