标签归档:documentation-tool

Sphinx-Sphinx文档构建器的主存储库

Sphinx是一个由Georg Brandl编写的工具,它可以很容易地为Python项目创建智能而漂亮的文档(或其他由多个reStrinredText源组成的文档)。它最初是为新的Python文档创建的,具有用于Python项目文档的优秀工具,但也支持C/C++,并计划使用更多语言

Sphinx使用reStrutiredText作为其标记语言,它的许多优点来自于reStrtifredText及其解析和翻译套件Docutils的强大和直截了当

它的功能包括以下几个方面:

  • 输出格式:HTML(包括HTML帮助、epub和Qt帮助等衍生格式)、纯文本、手册页和LaTeX或使用rst2pdf直接输出PDF
  • 广泛的交叉引用:函数、类、术语表术语和类似信息的语义标记和自动链接
  • 层次结构:轻松定义文档树,自动链接到兄弟、父代和子代
  • 自动索引:一般索引和模块索引
  • 代码处理:使用Pygments高亮显示笔自动高亮显示
  • 使用JJJA2模板引擎灵活的HTML输出
  • 各种扩展都是可用的,例如,用于自动测试摘录和包括适当格式化的文档字符串
  • Setuptools集成

有关更多信息,请参阅the documentation

安装

狮身人面像发表于PyPI并且可以从那里安装:

pip install -U sphinx

我们还发布测试版:

pip install -U --pre sphinx

如果您希望出于开发目的安装Sphinx,请参阅the
contributors guide

文档

文档可从以下网址获得:sphinx-doc.org

保持联系

  • 报告错误、建议功能或查看源代码on GitHub
  • 对于定义不明确的问题或想法,请使用mailing list

请遵守我们的code of conduct

测试

持续测试由Travis(对于Linux上的单元测试和样式检查),AppVeyor(适用于Windows上的单元测试),以及CircleCI(适用于像TeX编译这样的大型进程)

有关在本地运行测试的信息,请参阅the contributors guide

贡献

请参阅the contributors guide

版本签名

版本使用以下密钥签名: