我有一个Python项目，在函数中写了很多docstring，
如何通过一两步将那些docstring转换成html文档，
我只是希望 Sphinx 可以充当 doxygen，只需将我所有的评论或 doctring 转换为 html 文档即可。
我在 docs 文件夹下运行 sphinx-quickstart
然后
> 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
生成的代码在这里download
我按照教程进行操作，但是当我打开 index.html 时，我什么也没有，html 文件中没有列出任何模块和方法 link
.
├── docs
│ ├── _build
│ │ ├── doctrees
│ │ └── html
│ │ ├── _sources
│ │ └── _static
│ ├── _static
│ ├── _templates
│ └── html
└── src
├── long_term_streaming_monitor
│ ├── log
│ ├── scripts
│ └── tests
│ └── log
└── long_term_streaming_monitor_.egg-info
最佳答案
如评论之一所述，您可以使用 sphinx.ext.autodoc
快速入门的更多步骤 here .
检查示例配置文件 here
奖励 - 您还可以使用 travis-sphinx 将 Travis 与 sphinx 集成每次推送带有新文档字符串的代码时自动生成你的 github 页面。
关于python - 如何从文档字符串生成html文档，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/22600886/