sphinxcontrib-apidoc 0.3.0

概述

sphinx apidoc 是自动生成sphinx源的工具， 使用autodoc扩展名，在 其他自动api文档工具的样式。 Sphinx Apidoc 没有 实际上，它只是生成文档。因此，它 必须在狮身人面像构建之前运行。这通常会导致 tox.ini 文件 如下所示：

[testenv:docs]commands=
  sphinx-apidoc -o doc/api my_code my_code/tests
  sphinx-build -W -b html doc doc/_build/html

此扩展消除了将该配置保留在sphinx外部的需要。 相反，可以从 文档的conf.py文件，就像这样：

extensions=['sphinxcontrib.apidoc',# ...]apidoc_module_dir='../my_code'apidoc_output_dir='reference'apidoc_excluded_paths=['tests']apidoc_separate_modules=True