title: python sphinx安裝和qt學習之路(2)的html生成
id: 194
categories:

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

Sphinx 是一種工具，它允許開發(fā)人員以純文本格式編寫文檔，以便采用滿足不同需求的格式輕松生成輸出。這在使用 Version Control System 追蹤變更時非常有用。純文本文檔對不同系統(tǒng)之間的協(xié)作者也非常有用。純文本是當前可以采用的最便捷的格式之一。

雖然 Sphinx 是用 Python 編寫的，并且最初是為 Python 語言文檔而創(chuàng)建，但它并不一定是以語言為中心，在某些情況下，甚至不是以程序員為中心。Sphinx 有許多用處，比如可以用它來編寫整本書！
<div>

1

突出顯示

默認情況下，Sphinx 會為 Python 突出顯示代碼，但它還允許定義其他編程語言，比如 C 和 Ruby。

2

</div>
可以將 Sphinx 想像成為一種文檔框架：它會抽象化比較單調(diào)的部分，并提供自動函數(shù)來解決一些常見問題，比如突出顯示標題索引和特殊代碼（在顯示代碼示例時），以及突出顯示適當?shù)恼Z法。

我們下載qt學習之路(2)的rst文件,

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

git clone 就可以了,

3

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

• Makefile：編譯過代碼的開發(fā)人員應該非常熟悉這個文件，如果不熟悉，那么可以將它看作是一個包含指令的文件，在使用 make 命令時，可以使用這些指令來構(gòu)建文檔輸出。
• _build：這是觸發(fā)特定輸出后用來存放所生成的文件的目錄。
• _static：所有不屬于源代碼（如圖像）一部分的文件均存放于此處，稍后會在構(gòu)建目錄中將它們鏈接在一起。
• conf.py：這是一個 Python 文件，用于存放 Sphinx 的配置值，包括在終端執(zhí)行 sphinx-quickstart 時選中的那些值。
• index.rst：文檔項目的 root 目錄。如果將文檔劃分為其他文件，該目錄會連接這些文件。