先去文具店買紙筆
1. 買紙(Python)
位置:Python的官方網(wǎng)站
64位安裝程序
32位安裝程序
付錢:下載好以后直接運行.exe文件安裝粱腻,那樣紙就準(zhǔn)備好了
2. 買筆(Sphinx)
位置:本機(jī)的命令行窗口
- 在桌面左下角Windows 圖標(biāo)下右擊滔驶,點擊運行萝快,在彈出框中輸入 cmd
- 在桌面左下角Windows 圖標(biāo)下右擊吏口,點擊運行,在彈出框中輸入 Windows PowerShell
付錢:
在打開的命令行窗口戈盈,直接鍵入pip install -U Sphinx
字母 U 和字母 S 大寫,一定要注意哇,不然這個命令是無效嘚
店家給你備貨現(xiàn)場:
image.png
到手:
image.png
準(zhǔn)備就緒,文思泉涌
3. 打開筆蓋
在命令行界面輸入 sphinx-quickstart
啟動之后,Sphinx 會問你許多問題圣蝎,還會給出一些提示哮针,大部分只需回答是(y)或否(n)等太,少數(shù)需要鍵入項目名稱等,只要一一作答即可。
終于回答了所有問題,Sphinx 會為我們創(chuàng)建一個基本的文檔結(jié)構(gòu)竿音,包括1個 source 文件夾
image.png
2個 makefile 的文件
image.png
4. 分章寫作
在source 文件夾里添加我們用 rst 寫好的一個個文檔
5. 編纂目錄
打開source 文件夾中的index.rst 文件绪氛,在目錄樹 toctree 里面添加我們寫的文檔信息
昭告天下
6. 出版
在命令行里輸入 make html
Sphinx 會為我們生成一個 build 文件夾,里面就是發(fā)布好的 html 文件了,這樣我們的文檔就按照 toctree 的層級編纂好了
完美~