[sphinx]生成文檔的工具

• 安裝:

1 pip install sphinx

• 新建文檔項目

1 sphinx-quickstart

配置一些設置選項, 生成項目文件

• 生成html

1 make html
2 .\make.bat html    #windows

• 主題安裝和使用

http://www.writethedocs.org/guide/tools/sphinx-themes/

 

Makefile：編譯過代碼的開發人員應該很是熟悉這個文件，若是不熟悉，那麼能夠將它看做是一個包含指令的文件，在使用 make 命令時，能夠使用這些指令來構建文檔輸出。

_build：這是觸發特定輸出後用來存放所生成的文件的目錄。

_static：全部不屬於源代碼（如圖像）一部分的文件均存放於此處，稍後會在構建目錄中將它們連接在一塊兒。

conf.py：這是一個 Python 文件，用於存放 Sphinx 的配置值，包括在終端執行 sphinx-quickstart 時選中的那些值。

index.rst：文檔項目的 root 目錄。若是將文檔劃分爲其餘文件，該目錄會鏈接這些文件。

 

reStructuredText 標記語法

https://pythonhosted.org/an_example_pypi_project/sphinx.html

 

詳細教程文檔:

http://zh-sphinx-doc.readthedocs.io/en/latest/index.html

 

教程:

https://www.jianshu.com/p/78e9e1b8553a