天天看點

Windows10環境下使用sphinx生成Html

必備環境:Python3.5+以上,jinjia2

本人使用pip安裝sphinx,未安裝pip的請安裝pip

pip install -U sphinx,

安裝完成後,使用下指令檢查是否安裝成功過是否安裝成功!

sphinx-build --version

如果需要使用最新的開發版,則使用指令:

pip install -U --pre sphinx

使用sphinx-quickstart開始建立文檔結構:

在桌面建立C:\Users\X250\Desktop\下建立一個sphinx檔案夾,然後執行下面的指令:

sphinx-quickstart

Windows10環境下使用sphinx生成Html

static dir 【_】,Project release 【】 我這裡直接回車。

Windows10環境下使用sphinx生成Html

其他的地方幾乎一直輸入y即可。

此時sphinx檔案夾下将生成以下檔案:

Windows10環境下使用sphinx生成Html

進入到source檔案夾,index.rst為主文檔,config為主目錄,如下圖:

Windows10環境下使用sphinx生成Html

index.rst的主要功能是作為歡迎頁面,并包含“目錄樹”(或toctree)的根。

歡迎頁面的内容以後再說,現在讓sphinx生成html,讓我們先預覽一下,其生成的html,執行下面的指令:

Windows10環境下使用sphinx生成Html
Windows10環境下使用sphinx生成Html
Windows10環境下使用sphinx生成Html
Windows10環境下使用sphinx生成Html

用浏覽器打開index.html,結果如下:

Windows10環境下使用sphinx生成Html

make html 也可以用 sphinx-build -b html sourcedir builddir 進行代替。

注意,要将sourcedir替換為source,即包含有conf.py和index.rst的目錄

make.bat和makefile實際上是sphinx-quickstart腳本建立的,其目的是能讓我們更快的執行相應的指令,

其根本也是使用sphinx-build指令,隻是簡化了我們的輸入操作。

make html無法生成單個html,有些要求下使用改指令很不友善。

使用 make singlehtml 則會生成單個html,這個html包含了所有内容,很給力!