Sphinx简单来说，是一个文档生成工具，用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。
和 DocBook一样，Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧，大家一定都曾有过上学时用Word痛苦地修改论文 的经验（没办法，在中国LaTex太小众），其中Word里面千奇百怪的可见或不可见的格式符、控制符一定玩弄了大家很久。而类似DocBook或 reStructuredText 一类的格式则完全采用文本文件来记录文字格式，各种格式控制字符完全可见，不会出现如Word里某个隐藏在段落末尾的莫名控制符导致文章之后的某些部分完 全乱掉，而完全找不到这个控制符的情况了。同时，完全采用纯文本文件进行记录，使得使用版本控制软件对编辑工作进行全程追踪和记录成为了可能。而最终通过 文本的源文件生成具有格式和样式的文本则完全是程序所进行的工作，避免了一切出错的可能。
使用Sphinx的项目有很多，著名的包括 Python , Django 的文档，全部是使用Sphinx 生成的。
-
原文地址：http://start-up-python.readthedocs.org/en/latest/setout/sphinx.html#sphinx 转载此文作为一个记录 Sphinx是python的文档工具，也非常适合用于记笔记，所以我们这次学习选择python-sphinx就无可厚非了。 下面我简单介绍一下这个工具，希望大家能在最短的时间内学会使用这个工具。 首先安装sphinx u
-
http://zh-sphinx-doc.readthedocs.org/en/latest/intro.html
-
Ubuntu Ubuntu安装非常简单，只需要输入以下命令即可： sudo apt-get install python-sphinx Windows 在Windows下安装Sphinx比较复杂一些。 安装Python 从Python官网 上下载合适版本的Python, 这里采用Python-2.7。 为后续步骤方便，假定安装目录为 C:\Python27 安装Setuptools或Dist
-
Sphinx 是一个工具，她能够轻易地创建智慧和优雅的文档，她是出自 Georg Brandl 之手，在BSD许可证下授权。
-
问题内容： 所以这是一个经常发生的问题，我没有资格解决它，但我需要解决它，因此我将必须学习。见这个问题的一个过时的/没有可行的解决方案，并为没有回答过类似的问题。 基本问题，我需要提供私有python模块的文档。该项目托管在gitlab上，我使用CI生成文档。它们对全世界都是可见的，这并不理想。这是一个已知问题，gitlab可能最终会提供解决方案。我等不了那么久。我的计划是使用此项目（crypto
-
问题内容： 我正在用Sphinx写一些文档，我只想为HTML文档而不是LaTeX文档打印某些文本块。某事告诉我我应该可以做到这一点，但我不知道如何做到。有谁知道如何做到这一点？ 问题答案： 不需要扩展名。只需使用指令即可。 （旧链接，摘自2010年的原始帖子） https://web.archive.org/web/20100129001557/http://sphinx.pocoo.org/ma
-
问题内容： 我在Python项目源代码中有一个字典，描述了默认配置值。字典很长。我想在Sphinx文档中以除“查看源代码”之外的其他格式查看字典，以便人们可以快速检查默认值。 当与Sphinx autodoc一起使用时，Sphinx是否提供选项来格式化类似于字典的变量以实现人类可读的格式？我目前正在使用转储整个模块，并将字典作为文档中的一个长字符串转储（没有换行符，漂亮的打印内容，任何东西）来获取
-
实体可以用来作这件事情 有两个文件一个是主文件docbook.xml，包含文件头和文档信息；另一个文件file.xml是文档内容，主文件如下： <?xml version='1.0' encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5/zh_cn" "http://www.oasis-open.org/
-
问题内容： 我正在使用Sphinx记录非Python项目。我想在每个子模块中分发文件夹，其中包含用于记录该模块文件的文件。然后，我想将这些文件吸收到主层次结构中，以创建整个设计的规范。 即： 我试图像这样在主文档toctree中包含文件： 但是，此错误消息导致： 警告：toctree包含对不存在的文档u’modules / module1 / docs / module1’的引用 是否无法以某种方