欢迎光临
以下是斯芬克斯的一些主要特征:
输出格式:HTML(包括Windows HTML帮助)、LaTeX(用于可打印PDF版本)、ePub、Texinfo、手册页、纯文本
广泛的交叉引用:的语义标记和自动链接函数、类、引用、词汇表术语和类似的信息
层次结构:轻松定义文档树,具有自动指向兄弟姐妹、父母和孩子的链接
自动索引:通用索引以及特定于语言的模块指数
代码处理:使用Pygments公司荧光笔
扩展名:代码段的自动测试,包含文档字符串从Python模块(API文档)通过内置扩展,以及更多功能,通过第三方扩展.
主题:通过修改输出的外观创建主题,并重复使用许多第三方主题.
贡献的扩展:数十个扩展由用户贡献; 其中大多数可从PyPI安装。
斯芬克斯使用重新结构化文本默认情况下为标记语言,并且可以读取MyST降价通过第三方扩展。这两者功能强大且易于使用,并且具有功能用于复杂的文档和发布工作流。它们都是建立在Docutils公司解析和编写文档。
参见下文了解如何浏览狮身人面像的文档。
开始
这些部分涵盖了开始使用狮身人面像的基本知识,包括从头开始创建和构建您自己的文档。
用户指南
这些部分涵盖了在各种情况下使用和扩展Sphinx的各种主题使用卡。它们是在许多情况下使用狮身人面像的综合指南假设对狮身人面像有更多的了解。如果您是斯芬克斯的新手,我们建议您从开始开始.
参考指南
参考文档在本质上更加完整和程序化,它是一个可以快速引用的信息集合。如果你愿意用例驱动的文档,请参见开始或用户指南.