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
