SPHINX的輸出文檔格式
- SPHINX的輸出文檔格式
- 更多信息
SPHINX的輸出文檔格式
用rst編寫,然后用sphinx-build進行編譯,還是效果相當不錯地,只要掌握了格式,可以一次編譯,多種格式輸出,主要是用的可能是html和pdf,不過其他格式也是具備的。
這些命令提供了廣泛的靈活性,以滿足各種輸出格式的需求,如下所示:
- HTML:
make html
生成HTML格式的文檔。 - 目錄HTML:
make dirhtml
生成HTML格式的文檔,每個目錄下都有一個名為index.html的文件。 - 單個HTML文件:
make singlehtml
生成一個單獨的大型HTML文件,這個比較方便分享。 - Pickle:
make pickle
生成Pickle文件。 - JSON:
make json
生成JSON文件。 - HTML幫助項目:
make htmlhelp
生成HTML格式的幫助項目。 - qthelp項目:
make qthelp
生成qthelp項目。 - Devhelp項目:
make devhelp
生成Devhelp項目。 - ePub:
make epub
生成ePub格式的電子書。 - LaTeX:
make latex
生成LaTeX格式的文檔,可以設置 PAPER=a4 或者 PAPER=letter。 - LaTeXPDF:
make latexpdf
生成LaTeX和PDF格式的文檔。 - LaTeXPDFJA:
make latexpdfja
生成LaTeX和PDF格式的文檔,使用platex/dvipdfmx編譯運行。 - 文本:
make text
生成文本文件。 - 手冊頁:
make man
生成手冊頁。 - Texinfo:
make texinfo
生成Texinfo格式的文檔。 - info:
make info
生成Texinfo格式的文檔,并通過makeinfo運行它們。 - 獲取gettext:
make gettext
生成PO消息目錄,用于多語種支持。 - 變更概覽:
make changes
生成所有已更改/添加/棄用項的概覽。 - XML:
make xml
生成Docutils原生XML文件。 - 偽XML:
make pseudoxml
為顯示目的生成偽XML-XML文件。 - 鏈接檢查:
make linkcheck
檢查所有外部鏈接的完整性。 - doctest:
make doctest
運行文檔中嵌入的所有doctest(如果啟用)。 - 覆蓋率:
make coverage
運行文檔的覆蓋率檢查(如果啟用)。 - 清理:
make clean
刪除構建目錄中的所有內容。
更多信息
Hi,XDJM們,更多信息歡迎移步我的主頁、CSDN或微信公眾號letsProgramming.
- 🐱 github
- 🏠 Homepage https://shaoguangleo.github.io
- CSDN CSDN http://blog.csdn.net/shaoguangleo
- 微信公眾號:letsProgramming