项目描述
斯芬克斯使创建智能且美观的文档变得容易。
Sphinx使用reStructuredText作为其标记语言,并且具有许多优点来自reStructuredText及其解析的强大和直截了当和翻译套件Docutils。
特征
输出格式:HTML、PDF、纯文本、EPUB、TeX、手册页等
广泛的交叉引用:语义标记和自动链接函数、类、词汇表术语和类似信息
层次结构:轻松定义文档树,具有自动指向兄弟姐妹、父母和孩子的链接
自动索引:通用索引和模块索引
代码高亮:使用Pygments荧光笔自动高亮显示
模板化:使用Jinja 2模板引擎的灵活HTML输出
扩展生态系统:有许多扩展可用,例如自动功能文档或使用Jupyter笔记本。
语言支持:Python、C、C++、JavaScript、数学等语言通过扩展。
有关更多信息,请参阅文档.
安装
以下命令从包索引.你会的需要Python和pip的有效安装。
pip(点阵) 安装 -U型 狮身人面像
贡献
我们感谢所有的贡献!请参阅贡献者指南对于信息。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪一个,请了解更多安装软件包.
来源分布
构建的分布