如何从docstring生成html文档

Question

我有一个 Python 项目，在函数中写了很多文档字符串，

如何通过一两步将这些 docstring 转换为 html 文档，

我只希望 Sphinx 可以充当 doxygen，只需将我所有的评论或文档转换为 html 文档。

我sphinx-quickstart在docs文件夹下运行

然后

> autodoc: automatically insert docstrings from modules (y/n) [n]: y

然后修改了conf.py long_term_streaming_monitor/docs/source/conf.py

sys.path.insert(0, os.path.abspath('../../src'))

因为我所有的源代码都放在 long_term_streaming_monitor/src

生成的代码在这里下载

我遵循了教程，但是当我打开 index.html 时，我什么也没得到，html 文件链接上没有列出模块和方法

.
??? docs
?   ??? _build
?   ?   ??? doctrees
?   ?   ??? html
?   ?       ??? _sources
?   ?       ??? _static
?   ??? _static
?   ??? _templates
?   ??? html
??? src
    ??? long_term_streaming_monitor
    ?   ??? log
    ?   ??? scripts
    ?   ??? tests
    ?       ??? log
    ??? long_term_streaming_monitor_.egg-info

Answer 1

正如您可以使用的评论之一中提到的sphinx.ext.autodoc

有关快速入门的更多步骤请参见此处。在这里
查看示例配置文件 额外的好处 - 您还可以使用travis-sphinx集成 Travis ，以便在每次使用新文档字符串推送代码时自动生成您的 github 页面。
sphinx