sphinx-build - 云端在线

程序：

您的姓名

sphinx-build - Sphinx 文档生成器工具

概要

狮身人面像 [选项]源目录>外向> [[档名 ...]

商品描述

狮身人面像 从文件中生成文档 并将其放在
.

狮身人面像 寻找 /conf.py 用于配置设置。
狮身人面像-快速入门(1) 可用于生成模板文件，包括 配置文件.

狮身人面像 可以创建不同格式的文档。 一种格式被选择
在命令行上指定构建器名称； 它默认为 HTML。 建设者也可以
执行与文档处理相关的其他任务。

默认情况下，所有过时的都会被构建。 仅对选定文件的输出可以
通过指定单个文件名构建。

可用构建器列表：

HTML HTML 文件生成。 这是默认构建器。

目录
HTML 文件生成，每个 HTML 文件都在一个单独的名为“index.html”的文件中
目录。

单页html
HTML 文件生成，所有内容都在一个 HTML 文件中。

帮助
为 CHM（编译的帮助文件）生成生成文件。

帮助 为 Qt 帮助集合生成生成文件。

开发帮助
为 GNOME Devhelp 帮助查看器生成文件。

胶乳 生成可编译为 PDF 文档的 LaTeX 输出。

男子 生成手册页。

文本信息
生成可以处理的 Texinfo 输出 制作信息 生成信息
文档。

EPUB 生成 HTML 输出的 ePub 电子书版本。

文本 生成文档的纯文本版本。

gettext的
生成用于内容翻译的 Gettext 消息目录。

变化
生成 HTML 文件，列出当前版本的更改/添加/弃用项目
记录的项目。

链接检查
检查源中所有外部链接的完整性。

泡菜 / JSON
生成用于 Web 应用程序的序列化 HTML 文件。

XML 生成 Docutils-native XML 文件。

伪xml
生成紧凑的漂亮打印的“伪 XML”文件，显示内部
中间文档树的结构。

配置

-b
要使用的生成器； 默认为 html。 请参阅上面的完整构建器列表。

-a 为所有文件生成输出； 没有这个选项只输出新的和改变的
文件生成。

-E 忽略缓存文件，强制从磁盘重新读取所有源文件。

-d
缓存文件的路径； 默认为/.doctrees。

-j 尽可能与 N 个进程并行构建。

-c
找到指定路径下的conf.py文件而不是.

-C 指定根本不使用 conf.py 文件。 配置只能设置
使用 -D 选项。

-D
覆盖配置文件中的设置。

-t
确定 行李牌 用于“仅”块。

-A
将值传递到 HTML 模板中（仅适用于 HTML 构建器）。

-n 在挑剔模式下运行，警告所有丢失的引用。

-v 增加详细程度（可以重复）。

-N 防止彩色输出。

-q 安静运行，只在 stderr 上打印警告和错误。

-Q 非常安静的操作，除了错误之外不要打印任何内容。

-w
除了 stderr 之外，还将警告和错误写入给定文件。

-W 把警告变成错误。

-T 显示异常的完整追溯。

-P 在异常时运行 Pdb。

使用 onworks.net 服务在线使用 sphinx-build