Question

我创建了一个使用setuptools的演示项目，其结构如下：

project/
 |- pizza/
 |   |- __init__.py
 |   `- margherita.py
 |
 |- README.rst
 |- setup.cfg
 `- setup.py

我正在尝试使用Sphinx自动生成此项目的文档。到目前为止，我已经尝试过：

# Generate a sphinx template
sphinx-quickstart
# Use default settings, except for project name, etc.
sphinx-apidoc -o source .
./setup.py build_sphinx

我觉得必须有一种更简单的方法来使用README，setup.py和docstrings自动生成此文档。

最终，我想为另一个使用Python C-api的项目自动生成apidocs。我找不到任何东西。

我的主要问题是：是否有更简单的方法来自动生成此文档？

Answer 1

要扩展setup.py以使其包含Sphinx的额外命令，您可以创建自定义命令。我已经编写了一个运行Sphinx apidoc的小例子，然后构建了doc源代码。使用setup.py中定义的源的项目名称，作者，版本和位置（假设它们已定义）。

class Sphinx(Command):
    user_options = []
    description = 'sphinx'

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        # metadata contains information supplied in setup()
        metadata = self.distribution.metadata
        # package_dir may be None, in that case use the current directory.
        src_dir = (self.distribution.package_dir or {'': ''})['']
        src_dir = os.path.join(os.getcwd(),  src_dir)
        # Run sphinx by calling the main method, '--full' also adds a conf.py
        sphinx.apidoc.main(
            ['', '--full', '-H', metadata.name, '-A', metadata.author,
             '-V', metadata.version, '-R', metadata.version,
             '-o', os.path.join('doc', 'source'), src_dir])
        # build the doc sources
        sphinx.main(['', os.path.join('doc', 'source'),
                     os.path.join('doc', 'build')])

然后该命令需要注册到入口点组distutils.commands。这里的命令名为sphinx。

from setuptools import setup

setup(
    # ...
    setup_requires = ['sphinx'],
    entry_points = {
        'distutils.commands': [
            'sphinx = example_module:Sphinx'
        ]
    }
)

我不知道如何处理C源，但这会让你开始。

Answer 2

sphinx-apidoc -F -o source .

将使用sphinx-quickstart生成项目并递归查找python模块

你现在的效率和目前一样高。

===这里只是一厢情愿= =

如果你可以打电话给

，那会不会很可爱

./setup.py build_sphinx -C

它会创建你index.RST，读取你敲过的任何RST文件，解析所有的文档字符串并吐出一些HTML。

使用setuptools自动生成Python项目的文档

2 个答案: