Sphinx
https://www.sphinx.org.cn/
Sphinx是一个工具,可以轻松创建由Georg Brandl编写并根据BSD许可证授权的智能和美观文档
它最初是为Python文档创建的,它具有出色的工具,可用于各种语言的软件项目文档。 当然,这个站点也是使用reStructuredText源创建的
- 输出格式: HTML(包括Windows HTML帮助),LaTeX(适用于可打印的PDF版本),ePub,Texinfo,手册页,纯文本
- 广泛的交叉引用: 语义标记和功能,类,引用,词汇表术语和类似信息的自动链接
- 分层结构: 轻松定义文档树,自动链接到平级,上级和下级
- 自动索引: 一般索引以及特定于语言的模块索引
- 代码处理: 使用Pygments荧光笔自动突出显示
- 扩展: 自动测试代码片段,包含Python模块(API文档)中的文档字符串等
- 贡献的扩展: 用户在第二个存储库中贡献了50多个扩展;其中大多数可以从PyPI安装
入门
https://www.sphinx.org.cn/usage/quickstart.html
例子
https://github.com/plasmatech8/Python-Sphinx-Demo