文檔

整體思路：

• Sphinx 生成文檔
• GitHub 托管文檔
• 導入到 Read the Docs 生成在線文檔

Sphinx

Mac安裝

brew install sphinx-doc

安裝包

pip install sphinx pip install sphinx_rtd_theme pip install recommonmark

進入docs文件夾，執行

sphinx-quickstart

source作為Sphinx的根目錄，被稱為source directory。按需修改其中的配置source/conf.py.
該目錄中，包含配置文件conf.py，用來配置sphinx怎樣讀取source文件以及建立文檔。
由于conf中需要recommonmark>=0.7.1包，因此加到requirements.txt里。

增加其中的文檔，rst，例如

index.rst

生成文檔

make clean make html

參考

• https://zhuanlan.zhihu.com/p/264647009

總結

以上是生活随笔為你收集整理的开源python-文档撰写的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。