欢迎

用户评论:

欢呼!这个伟大的工具让程序员愿意去写文档了!

Sphinx这个工具,可以方便地创建智能而美观的文档,作者是 Georg Brandl,发布的协议是BSD协议。

本项目最初是为了Python官方文档,它对各种软件文档的支持极佳。当然,本网站也是使用 Sphinx 和 reStructuredText 源码写成的! 它具有以下特色:

  • 输出格式:HTML(包括Windows HTML帮助),LaTeX(生成可打印的PDF文档),ePub,Texinfo,manpages,纯文本格式
  • 交叉引用:对函数、类、引用、词汇表,以及类似的内容提供语义标记并自动建立链接
  • 组织结构:易于上手的文档树结构,自动链接到当前级别、上级、下级的其他内容
  • 建立索引:文档目录,以及针对特定语言的模块索引
  • 代码样式:使用 Pygments 自动高亮代码
  • 扩展功能:自动测试代码片断,引入其他 Python 模块 API 文档中的 docstring,以及更多内容
  • 用户模块:由其他用户贡献的超过 50 个扩展模块,在另外的软件仓库中;多数都可以从 PyPI 直接安装

Sphinx 使用 reStructuredText 作为标记语言,很多强大的功能都直接来自于 reStructuredText,以及它使用的编译工具包,Docutils

文档

您也可以下载Sphinx文档的PDF/EPUB版本 从右下角的弹出菜单。

实际案例

使用 Sphinx 生成其文档的项目,可以在 使用 Sphinx 的工程项目页面查看。

要查看 Sphinx 源码文件的样例,点击 “本页:显示源代码”的链接即可,除了你现在看到的欢迎页面, 其他页面都会显示这个链接。

你可能对 matplotlib 开发者编写的 精致的教程感兴趣, 它讲解了如何使用 Sphinx 编写定制化的文档。

翻译部有一个翻译团队 感谢sphinx文件翻译器。

奥莱利出版了一本关于sphinx的日本书: 1 sphinxをはじめよう/ 学习sphinx。

2019年,一本关于sphinx的德国书第二版出版: 1 软件Dokumentation mit Sphinx 1。

文档页面托管

需要一个网页空间展示你的 Sphinx 文档? readthedocs.org网站上已经有大量的 Sphinx 制作的文档了,它可以很好地与源码管理软件配合起来工作。 这个网站不仅可以使用 Sphinx 生成的基于 JavaScript 的搜索,还另外支持更加强大的全文搜索。

贡献指南

如果你想为此项目贡献代码,就应该阅读此部分文档

行为准则

请遵守我们的1行为准则1。