用sphinx將reStructuredText開源書籍轉(zhuǎn)化成其他格式
By qianghaohao
今天在github看到了一個(gè)項(xiàng)目,是用reStructuredTex標(biāo)記語言寫的開源書籍,然后下載下來閱讀,
結(jié)果發(fā)現(xiàn)下載下來的目錄里面有很多各種格式的文件,并不能直接閱讀,需要用sphinx編譯成我們
可以閱讀的格式,才可以看。比如html,pdf等格式。
一.sphinx工具簡(jiǎn)介:
sphinx工具是一個(gè)由Grorg Brandl寫的產(chǎn)生文檔的工具,可以將reStructuredTex格式轉(zhuǎn)化成
多種格式,如HTML,LaTex,ePub,Texinfo,manual pages,plain text等。
二.使用sphinx編譯開源書籍項(xiàng)目產(chǎn)生html格式的文檔:
2.安裝Python:
安裝完后配置好paht環(huán)境變量:
3.安裝pip工具(用來下載和安裝第三方庫(kù)的工具):
然后打開命令提示符用Python運(yùn)行上面保存Python文件來安裝pip:
接下來配置pip工具的環(huán)境變量:
4.用pip工具安裝sphinx:
5.進(jìn)入工程目錄查看makefile,然后開始編譯:
查看工程目錄中的makefile:
我們可以看到makefile中有多個(gè)目標(biāo),每個(gè)目標(biāo)代表一種格式,可以編譯成多種格式,在此我編譯成了
html格式的文檔,所以下達(dá)如下命令開始編譯:
編譯完成后會(huì)提示編譯結(jié)果輸出到了那個(gè)目錄,在此輸出到了_build目錄:
三.編譯結(jié)果如下:
進(jìn)入到_build輸出目錄,可以看到我們編譯產(chǎn)生的html文檔,打開index.html結(jié)果如下:
本文參考資料:
|