含 Sphinx 的 MyST¶
MyST 解析器捆绑了一个 Sphinx 插件,允许你完全在 MyST(或者,在 rST 和 MyST 的组合)中编写 Sphinx 文档。下面的章节涵盖了 Sphinx 插件的一些主要功能。
参见
关于带 Sphinx 的 MyST 的介绍,见 在 Sphinx 中开始使用 MyST。
- Sphinx extension usage guide
- Include rST files into a Markdown file
- Include Markdown files into an rST file
- Use MyST in Jupyter Notebooks
- Include a file from outside the docs folder (like README.md)
- Use
sphinx.ext.autodoc
in Markdown files - Automatically create targets for section headers
- Suppress warnings
- Sphinx-specific page front matter
- Migrate pre-existing rST into MyST
- Special roles and directives
- Sphinx configuration options
- Common errors and questions