目錄：
一、Read the Docs簡介
Read the Docs 是一個軟件文檔託管平臺。源代碼是開源的，服務也是免費的。它支持使用 reStructuredText 編寫的 Sphinx 文檔，並且支持 Subversion，Bazaar，Git 和 Mercurial 等。 Sphinx 是一個文檔生成工具，最初是爲編寫 Python 文檔創建的，現在它擁有出色的工具，可以用於各種語言編寫的軟件項目。reStructuredText 是一個易於閱讀的純文本標記語法和解析器系統。reStructuredText 是對 StructuredText 和 Setext 輕量級標記系統的修訂和重新解釋。
二、Sublime Text 配置
使用 Sublime Text 編輯器編寫 reStructuredText 文件。安裝好 Sublime Text 後，爲了方便編寫 rst 文件，需要安裝插件 OmniMarkupPreviewer。通過 Package Control 安裝插件。
1、安裝Package Control
同時按住 "Ctrl + ` " 打開 Sublime Text 的控制檯，根據 Package Control 安裝提示，將相應的安裝代碼複製到 console：
2、安裝插件
同時按住 " Ctrl + Shift + p " 打開命令面板，輸入 install 選擇 Install Package 選項，然後即可在列表中查詢要安裝的插件，例如 OmniMarkupPreviewer：
還可以到Github上查看 OmniMarkupPreviewer 的其他安裝方式。
安裝好 OmniMarkupPreviewer 後，在 Windows 平臺下，按下Ctrl + Alt + o即可在瀏覽器中查看編寫好的 rst 文檔。
三、Sphinx使用
1、安裝Sphinx
不同平臺的安裝方法，請查看Sphinx官網。本文以 Windows 平臺爲例。
conda install sphinx
2、創建目錄
mkdir Pillow_docs_cn
3、運行 sphinx-quickstart
Sphinx 提供了一個工具 sphinx-quickstart，它將生成一個文檔源目錄並使用默認值填充它。
cd Pillow_docs_cn
sphinx-quickstart
運行後會生成如下文件：
4、reStructuredText 文檔構成的 Sphinx 集合的根目錄稱爲源目錄(source directory)。 該目錄包含 Sphinx 配置文件 conf.py，可以在該文件配置 Sphinx，例如指定如何讀取源文件和構建文檔等。主文檔 index.rst，主文檔的主要作用是用作歡迎頁，並且包含目錄樹表(table of contents tree, toctree)的根。
5、定義文檔結構
打開 index.rst 文件，可以看到 toctree 指令最初爲空，如下所示：
.. toctree::
:maxdepth: 2
添加文檔目錄內容：
.. toctree::
:maxdepth: 2
installation.rst
handbook/index.rst
reference/index.rst
porting.rst
about.rst
創建文檔
7、運行創建工具
sphinx-quickstart 創建了 Makefile 文件和 make.bat 文件。只需運行 make 命令即可。例如：
make html
使用 make 命令可以指定文件格式，上述命令在 build 目錄下生成了一個 HTML 文檔。
四、連接 Github
可將編寫好的 rst 文件上傳至 Github，然後從 readthedocs 導入 Github 項目，這樣可通過 readthedocs 對文檔進行編譯、版本控制等。
將 Github 賬號與 readthedocs 賬號關聯後，即可導入 Github 項目：
點擊 Import a Project 按鈕，即可看到 Github 項目列表，選擇項目導入，對文檔進行操作：
點擊 Builds 按鈕，對文檔進行編譯，編譯成功後點擊 View Docs 按鈕，即可查看文檔：
