让我们聊聊 Jamstack 的未来 — 加入我们

Sphinx

5646 星星
1864 关注
1128 问题
主页
https://sphinx-doc.cn/
存储库
sphinx-doc/sphinx
语言
Python
许可证
BSD-2-Clause
模板
Jinja2

Sphinx 是一个工具,它使创建智能且美观的文档编撰变得容易,由格奥尔格·布兰德尔编写,并根据 BSD 许可协议授权。

它最初为新的 Python 文档创建,并且具有用于 Python 项目文档编撰的极佳功能,但 C/C++ 也已经得到支持,并且计划对其他语言也添加特殊支持。当然,此站点也是使用 Sphinx 从 reStructuredText 源代码创建的!应该重点关注以下特性

  • 输出格式:HTML(包括 Windows HTML 帮助)、LaTeX(用于可打印 PDF 版本)、ePub、Texinfo、手册页、纯文本
  • 广泛的交叉引用:函数、类、引文、词汇表术语和类似信息的语义标记和自动链接
  • 层次结构:轻松定义一个文档树,并自动链接兄弟、父项和子项
  • 自动索引:通用索引以及特定语言的模块索引
  • 代码处理:使用 Pygments 高亮显示器进行自动高亮显示
  • 扩展:自动测试代码片段、从 Python 模块(API 文档)包含文档字符串等
  • 贡献的扩展:在另一个存储库中,用户贡献的超过 50 个扩展;大多数可从 PyPI 安装

Sphinx 使用 reStructuredText 作为其标记语言,其许多优势来自 reStructuredText 的功能和简洁性及其解析和转换组件 Docutils。

查找更多 静态网站生成器