如何自动插入sphinx-apidoc类图,无需追逐最新代码

时间:2017-03-16 01:18:07

标签: python python-sphinx

我想生成我的Python程序的文档。

当我生成文档时,我总是执行sphinx-apidoc来追逐最新的代码,然后执行make html

$ sphinx-apidoc -f -o doc .
$ make -C doc html

我使用sphinx.ext.inheritance_diagram生成类图。如果将以下文本插入.rst文件手动,则可以生成类图。

.. inheritance-diagram:: mymodule.MyClass1 mymodule.MyClass2
    :parts: 1

但是sphinx-apidoc -f删除了上述文字。我想知道如何将类图插入sphinx-apidoc 自动,而不会丢失追逐最新代码。

如果可能的话,我想指定插入类图的位置(例如,在每个.. automodule::或其他任何好的方法之前)。

我的环境:

$ python3 --version
Python 3.5.2
$ pip3 --version
pip 8.1.1 from /usr/lib/python3/dist-packages (python 3.5)
$ pip3 freeze | grep Sphinx
You are using pip version 8.1.1, however version 9.0.1 is available.
You should consider upgrading via the 'pip install --upgrade pip' command.
Sphinx==1.5.2

0 个答案:

没有答案