準(zhǔn)備工具
Python 3.4
Visual Studio Code
Git
1.安裝 sphinx和自動(dòng)build插件
pip install sphinx sphinx-autobuild
2.安裝 restructuredtext-lint
pip install restructuredtext-lint
3.VScode插件安裝
3.1安裝插件 reStructuredText
它提供了.rst文件的預(yù)覽功能十分便捷崔梗。
3.2安裝插件 Table Formatter
由于reStructuredText做表格特別麻煩吃引，這個(gè)插件可以幫助你做表格演怎，只需要把關(guān)鍵的標(biāo)記寫(xiě)對(duì)，其余的都會(huì)自動(dòng)補(bǔ)全而且效果十分美觀窄俏。
注意： 插件安裝完成之后需要點(diǎn)擊重新加載方能生效
4.新建寫(xiě)作項(xiàng)目
sphinx-quickstart
安裝主題
pip install sphinx_rtd_theme
實(shí)時(shí)預(yù)覽
sphinx-autobuild docs docs/_build/html
注意：
docs是你項(xiàng)目的文件夾名稱斜做，需要在項(xiàng)目的上一級(jí)目錄執(zhí)行以上指令朦佩。
運(yùn)行成功后，訪問(wèn)?http://127.0.0.1:8000
參考資料
[1] http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs
寫(xiě)最好的文檔：Sphinx + Read the Docs
[2] http://www.reibang.com/p/78e9e1b8553a
如何用 ReadtheDocs粗蔚、Sphinx 快速搭建寫(xiě)書(shū)環(huán)境
[3] http://www.sphinx-doc.org/en/stable/config.html
The build configuration file
[4] https://github.com/vscode-restructuredtext/vscode-restructuredtext/blob/master/docs/sphinx.md
reStructuredText入門(mén)
[5] http://www.pythondoc.com/sphinx/rest.html
