插件

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

本章描述了与 Sphinx 捆绑的插件。关于编写你自己的插件的 API 文档，请参考 为 Sphinx 开发插件。

内置插件

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

三方插件

你可以在 sphinx-contrib 组织中找到几个由用户贡献的插件。如果你想把你的插件加入这个组织，只需按照 github-administration 项目中提供的说明即可。这是可选的，有几个插件托管在其他地方。awesome-sphinxdoc 项目包含一个精心策划的 Sphinx 软件包列表，许多软件包使用 Framework :: Sphinx :: Extension 和 Framework :: Sphinx :: Theme 的分类器，分别用于 Sphinx 的插件和主题。

在哪里放自己的插件？

项目本地的插件应该放在项目的目录结构中。相应地设置 Python 的模块搜索路径，sys.path，以便 Sphinx 能找到它们。例如，如果你的插件 foo.py 位于项目根目录下的 exts 子目录中，就放到 conf.py

import sys, os

sys.path.append(os.path.abspath('exts'))

extensions = ['foo']

你也可以在 sys.path 上的其他地方安装插件，例如在 site-packages 目录下。