如何从docstring生成html文档

Question

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

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

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

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

然后

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

然后修改了 conf.py long_term_streaming_monitor 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与sphinx集成，以便在每次使用新文档字符串推送代码时自动生成github页面。

Answer 2

如果您发现Sphinx很麻烦，特别适合小型，简单的项目，请尝试使用pdoc 。