如何从我的Python模块中制作sphinx-quickstart自动包含文档字符串

时间:2017-05-18 21:48:32

标签: python python-sphinx

我正在尝试使用Sphinx为Python项目生成文档。为了确保我能够真正实现它,我已经做了一个测试项目来尝试:https://github.com/ThomasA/sphinxtest

我已在此存储库的根目录中运行sphinx-quickstart。在以下问题中,我指定了' doc'作为文档根,命名项目' sphinxtest',输入' Thomas Arildsen'作者,回答' y'到了#autodoc'选项,并选择其他所有内容的默认设置。

我期待着' autodoc'导致生成文件的选项' amodule.rst'在' doc'夹。但是,这不会生成。我很困惑。我认为这就是' autodoc'选项本来应该做的,我看到的其他人的例子显然是用它实现的。 Sphinx完成时没有任何错误消息,因此它似乎正在做它认为应该做的事情。那么,我可能做错了什么?

我正在使用Sphinx v.1.5.6和Python 3.5.3,所有这些都与Anaconda一起安装。

2 个答案:

答案 0 :(得分:1)

autodoc不会生成.rst源文件。

而是先使用sphinx-apidoc生成源文件。然后运行Sphinx来制作文档。

答案 1 :(得分:0)

Percy的回答是Carlos Jenkins写的 autoapi 。他提供了一个Sphinx扩展,可以为每个文档生成生成ReST文件。您可以通过修改模板文件来配置输出ReST。

https://github.com/carlos-jenkins/autoapi