快速入门

myst-nb 作为 Python 包分发，不需要非 Python 依赖项。

使用 pip 安装 myst-nb：

pip install myst-nb

你可以使用 mystnb-quickstart CLI 快速创建示例 Sphinx + MyST-NB 项目：

mystnb-quickstart my_project/docs/

或者简单地将 myst_nb 添加到现有的 Sphinx 配置中：

extensions = [
    ...,
    "myst_nb"
]

默认情况下，MyST-NB 现在将解析 markdown（.md）和笔记本（.ipynb）。

Begin authoring your content

完成内容编写后，您现在可以使用 sphinx-build CLI 来构建您的文档，例如：

sphinx-build -nW --keep-going -b html docs/ docs/_build/html

小技巧

MyST-NB 支持并行构建，因此您还可以通过以下方式在 N 个进程上分发构建（和执行笔记本）： sphinx-build -j 4

执行环境与您的 Sphinx 环境相同

您的 Sphinx 构建与构建期间执行的笔记本共享相同的环境。在构建文档时，请确保调用正确的 sphinx-build 命令，否则运行笔记本所需的环境可能不正确。如果您在构建日志中看到 Extension error 或来自 jupyter-cache 的错误，通常会发生这种情况。

参见

查看 Read the Docs 以托管和 持续部署 文档