Sphinx 文档生成器
Sphinx简介
Sphinx,Python第三方库,文档生成器,使用reStructuredText作为其标记语言。
Sphinx的一些特征
- 输出格式:HTML(包括Windows HTML帮助)、LaTeX(用于可打印的PDF版本)、ePub、Texinfo、手册页、纯文本等;
- 广泛的交叉引用:函数、类、引文、词汇表术语和类似信息的语义标记和自动链接;
- 层次结构:轻松定义文档树;
- 自动索引:通用索引和特定语言模块索引;
- 代码处理:使用Pygments荧光笔自动高亮显示;
- 主题:通过创建主题来修改输出的外观,并重用许多第三方主题;
- 扩展:自动测试代码片段,通过内置扩展包含Python模块(API文档)中的文档字符串,以及通过第三方扩展提供更多功能;
- 贡献的扩展:用户贡献的数十个扩展;其中大多数可从PyPI安装;
Sphinx Github统计数据
BSD-2-Clause
Github 5.8k stars
Sphinx安装命令
pip install -U sphinx
Sphinx Python版本要求
Sphinx 7.2.6 Python >=3.9(数据来源pypi)
免责声明:内容编辑自网络,仅供参考,不保证正确性,不作任何决策依据!!以上数据皆截止于博文的写稿日期。