python sphinx安装和qt学习之路(2)的html生成

title: python sphinx安装和qt学习之路(2)的html生成
id: 194
categories:

• qt
  date: 2015-09-28 15:26:52
  tags:

---

Sphinx 是一种工具，它允许开发人员以纯文本格式编写文档，以便采用满足不同需求的格式轻松生成输出。这在使用 Version Control System 追踪变更时非常有用。纯文本文档对不同系统之间的协作者也非常有用。纯文本是当前可以采用的最便捷的格式之一。

虽然 Sphinx 是用 Python 编写的，并且最初是为 Python 语言文档而创建，但它并不一定是以语言为中心，在某些情况下，甚至不是以程序员为中心。Sphinx 有许多用处，比如可以用它来编写整本书！
<div>

1

突出显示

默认情况下，Sphinx 会为 Python 突出显示代码，但它还允许定义其他编程语言，比如 C 和 Ruby。

2

</div>
可以将 Sphinx 想像成为一种文档框架：它会抽象化比较单调的部分，并提供自动函数来解决一些常见问题，比如突出显示标题索引和特殊代码（在显示代码示例时），以及突出显示适当的语法。

我们下载qt学习之路(2)的rst文件,

https://github.com/youngjeff/qt-study-road-2

git clone 就可以了,

3

然后进入qt-study-road-2 ,make html

• Makefile：编译过代码的开发人员应该非常熟悉这个文件，如果不熟悉，那么可以将它看作是一个包含指令的文件，在使用 make 命令时，可以使用这些指令来构建文档输出。
• _build：这是触发特定输出后用来存放所生成的文件的目录。
• _static：所有不属于源代码（如图像）一部分的文件均存放于此处，稍后会在构建目录中将它们链接在一起。
• conf.py：这是一个 Python 文件，用于存放 Sphinx 的配置值，包括在终端执行 sphinx-quickstart 时选中的那些值。
• index.rst：文档项目的 root 目录。如果将文档划分为其他文件，该目录会连接这些文件。