sphinx-ext-mystmd

从Sphinx项目构建MyST-MD AST的Sphinx扩展。这可以用于

1. 在MyST项目中嵌入API文档
2. 为已部署的Sphinx项目提供MyST xref支持（逐步过渡）

将此扩展添加到您的 conf.py 例如。

extensions = ["sphinx_ext_mystmd"]

以使用 myst 构建器，例如。

sphinx-build -b myst . <BUILDDIR>

在 <BUILDDIR> 中生成的 .myst.json 文件可以添加到您的目录中，例如使用一个 pattern 条目，例如。

project:
  toc:
    - file: index.md
    - title: Sphinx Build
      children:
        - pattern: <BUILDDIR>/**.myst.json

您还可以为您的网站构建一个xref发行版，这允许MyST项目在文档中进行丰富的交叉引用。

运行

sphinx-build -b myst-xref . <BUILDDIR>

将在 <BUILDDIR> 中生成一个 myst.xref.json。应将 <BUILDDIR> 的内容添加到您网站根目录。

[!WARNING] 此扩展是一个工作在进行的直接作品；有些事情不起作用。意图是在我们最终确定它之前在页面上显示 某物。