SPHINX的输出文档格式

2024-06-01 11:36
文章标签 输出 文档 格式 sphinx

本文主要是介绍SPHINX的输出文档格式,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

微信公众号

这篇关于SPHINX的输出文档格式的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1020899

相关文章

浅谈Redis Key 命名规范文档

《浅谈RedisKey命名规范文档》本文介绍了Redis键名命名规范,包括命名格式、具体规范、数据类型扩展命名、时间敏感型键名、规范总结以及实际应用示例,感兴趣的可以了解一下... 目录1. 命名格式格式模板:示例:2. 具体规范2.1 小写命名2.2 使用冒号分隔层级2.3 标识符命名3. 数据类型扩展命

使用Python开发Markdown兼容公式格式转换工具

《使用Python开发Markdown兼容公式格式转换工具》在技术写作中我们经常遇到公式格式问题,例如MathML无法显示,LaTeX格式错乱等,所以本文我们将使用Python开发Markdown兼容... 目录一、工具背景二、环境配置(Windows 10/11)1. 创建conda环境2. 获取XSLT

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

Android实现在线预览office文档的示例详解

《Android实现在线预览office文档的示例详解》在移动端展示在线Office文档(如Word、Excel、PPT)是一项常见需求,这篇文章为大家重点介绍了两种方案的实现方法,希望对大家有一定的... 目录一、项目概述二、相关技术知识三、实现思路3.1 方案一:WebView + Office Onl

HTML5表格语法格式详解

《HTML5表格语法格式详解》在HTML语法中,表格主要通过table、tr和td3个标签构成,本文通过实例代码讲解HTML5表格语法格式,感兴趣的朋友一起看看吧... 目录一、表格1.表格语法格式2.表格属性 3.例子二、不规则表格1.跨行2.跨列3.例子一、表格在html语法中,表格主要通过< tab

Python实现word文档内容智能提取以及合成

《Python实现word文档内容智能提取以及合成》这篇文章主要为大家详细介绍了如何使用Python实现从10个左右的docx文档中抽取内容,再调整语言风格后生成新的文档,感兴趣的小伙伴可以了解一下... 目录核心思路技术路径实现步骤阶段一:准备工作阶段二:内容提取 (python 脚本)阶段三:语言风格调

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

Java利用docx4j+Freemarker生成word文档

《Java利用docx4j+Freemarker生成word文档》这篇文章主要为大家详细介绍了Java如何利用docx4j+Freemarker生成word文档,文中的示例代码讲解详细,感兴趣的小伙伴... 目录技术方案maven依赖创建模板文件实现代码技术方案Java 1.8 + docx4j + Fr

Python将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞?二、准备如何搞?三、说搞咱就搞!抓取文章提取内容构建html转存markdown

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当