扩展

由于许多项目在其文档中需要特殊特性，Sphinx允许在构建过程中添加“扩展”，每个扩展几乎可以修改文档处理的任何方面。

本章介绍与Sphinx捆绑的插件。有关编写自己的扩展的API文档，请参阅 Sphinx API接口。

内置插件

这些插件是内置的，可以通过 extensions 配置值中的相应条目激活：

第三方插件

您可以在 sphinx-contrib 组织中找到用户贡献的几个插件。如果您希望将您的扩展包含在此组织中，只需按照 github-administration 项目中提供的说明进行操作。这是可选的，并且有几个插件托管在其他地方。awesome-sphinxdoc 和 sphinx-extensions 项目都是Sphinx软件包的策划列表，许多软件包分别使用 Framework :: Sphinx :: Extension 和 Framework :: Sphinx :: Theme 分类器作为Sphinx扩展和主题。

你自己的插件放到哪里？

项目本地的扩展应放在项目的目录结构中。相应地设置Python的模块搜索路径 搜索路径，以便Sphinx可以找到它们。例如，如果您的扩展 foo.py 位于项目根目录的 exts 子目录中，请将以下内容放入 conf.py：

import sys
from pathlib import Path

sys.path.append(str(Path('exts').resolve()))

extensions = ['foo']

您也可以在 sys.path 里的任何地方安装扩展，例如在 site-packages 目录中。