- 安裝sphinx
pip3 install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark sphinx-markdown-tables –user - 新建項目文件夾
mkdir my_project_name - 快速啟動
sphinx-quickstart
主要填下面信息，其他默認按回車鍵就行
Project name:
Author name(s):
- 編輯文檔
source/_static目錄放一些靜態(tài)文件，如image等。source/index.rst文檔中定義目錄結(jié)構(gòu)。source/conf.py為配置文件。推薦主題html_theme = ‘sphinx_rtd_theme’。此外默認不支持markdown，修改extensions和source_suffix如下：
extensions = [
'sphinx_markdown_tables',
'sphinxcontrib.mermaid',
]
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
- 編譯發(fā)布：項目主目錄里執(zhí)行
make html。
