" python setup.py build_sphinx"和" sphinx-apidoc - 隐藏命名空间"

时间:2017-06-26 22:55:43

标签: python-3.x python-sphinx namespace-package

sphinx-apidoc支持选项--implicit-namespaces来处理根据PEP420的命名空间包。当我使用" python setup.py build_sphinx"创建Sphinx文档时,默认情况下这不适用于命名空间包。 " python setup.py build_sphinx"之间是否有关系?和sphinx-apidoc(例如sphinx-apidoc隐式调用某处,当" python setup.py build_sphinx"运行?)?如果是这样,我可以用某种方式指定" python setup.py build_sphinx"应该考虑sphinx-apidoc的

1 个答案:

答案 0 :(得分:0)

查看“sphinx-quickstart”的输出向我展示了生成文档的3个步骤:

  1. “sphinx-quickstart”用conf.py和index.rst创建初始目录结构
  2. “sphinx-apidoc”生成* .rst文件,也可以进一步调整
  3. “make html”或“sphinx-build”或“python setup.py build_sphinx”或“devpi upload --with-docs”从* .rst文件生成HTML
  4. 因此,“python setup.py build_sphinx”不会隐式调用“sphinx-apidoc”,但必须一个接一个地调用它们。