Skip to content

Switch to Markdown documentation (MyST parser)#508

Merged
araffin merged 3 commits intomasterfrom
doc/markdown
Mar 13, 2026
Merged

Switch to Markdown documentation (MyST parser)#508
araffin merged 3 commits intomasterfrom
doc/markdown

Conversation

@araffin
Copy link
Copy Markdown
Member

@araffin araffin commented Mar 13, 2026

Description

Same as DLR-RM/stable-baselines3#2219

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format (required)
  • I have checked the codestyle using make check-codestyle and make lint (required)
  • I have ensured make pytest and make type both pass. (required)

Note: we are using a maximum length of 127 characters per line

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, .md source suffixes, MyST extensions/config).
  • Convert guide and API docs pages from .rst to .md (with MyST anchors and eval-rst blocks where needed), and replace the changelog page with a Markdown/include-based version.
  • Update requirements.txt to require a newer stable-baselines3 alpha.

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.

Comment thread docs/guide/train.md Outdated
Comment thread docs/guide/train.md Outdated
Comment thread docs/guide/install.md Outdated
Comment thread docs/guide/plot.md Outdated
Comment thread docs/guide/config.md Outdated
Comment thread docs/guide/integrations.md Outdated
Comment thread docs/guide/integrations.md Outdated
Comment thread docs/guide/integrations.md Outdated
Comment thread docs/guide/install.md Outdated
Comment thread docs/guide/install.md
Comment thread docs/guide/install.md Outdated
araffin and others added 2 commits March 13, 2026 16:33
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>
@araffin araffin merged commit bb4bdf1 into master Mar 13, 2026
8 checks passed
@araffin araffin deleted the doc/markdown branch March 13, 2026 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants