Skip to article frontmatterSkip to article content

Include Sphinx Projects in MyST

Gradually Upgrade Sphinx-based Projects to MyST

Configure Your Project

The Sphinx conf.py for your project should include sphinx-ext-mystmd. If your Sphinx project lives under sphinx, then your conf.py might look like.

sphinx/conf.py
extensions = [
    "sphinx_ext_mystmd"
]

Build the Sphinx Project

sphinx-build -b myst sphinx myst-asts

Configure the MyST Project

myst.yml
version: 1
project:
  toc:
    - file: index.md
    - pattern: myst-asts/**.myst.json
site:
  template: book-theme

Build the MyST Project

myst start