记录插件

你应该这么做。如果你不使用，没有人会使用你的插件。或者如果他们使用了插件，他们会在出现问题的时候诅咒你。

记录插件的一个简单方法是使用nose2 Sphinx 扩展，它提供 autoplugin 从插件类中生成合适的参考文档的指令。

要使用它，请添加 nose2.sphinxext 到 extensions 列在 conf.py 文档目录中的文件。

然后添加 autoplugin 指示 *.rst 文件，如下：

.. autoplugin :: mypackage.plugins.PluginClass

这将产生包含插件加载的配置变量的输出 __init__ 以及插件注册的任何命令行选项。这就是为什么你 真正地 应提取配置变量并在中注册命令行选项 __init__ .

输出还包括 autoclass 插件类的部分，这样您可以在插件的docstring中放入更多的叙述性文档，供用户阅读。

当然，你可以也应该在参考文档之前写一些词来解释你的插件的功能和使用方法。你可以把这些话写在 *.rst 文件本身，或者在插件所在模块的docstring中。