rst-buildhtml - 云端在线

程序：

您的姓名

rst-buildhtml - 将许多 reST 文档转换为 HTML

概要

rst-buildhtml [选项] [ ...]

商品描述

从每个文件中的所有 reStructuredText .txt 文件（包括 PEP）生成 .html
（默认为当前目录）。

配置

一般用途总体评估 文档工具 可选项
--标题=题目
将文档标题指定为元数据。

- 发电机, -g
包括“由 Docutils 生成”的信用和链接。

--无发电机
不包括发电机信用。

- 日期, -d
在文档末尾添加日期 (UTC)。

- 时间, -t
包括时间和日期 (UTC)。

--无日期戳
请勿包含任何类型的日期戳。

--源链接, -s
包括“查看文档源”链接。

--源网址=
用对于源链接； 暗示--source-link。

--无源链接
不要包含“查看文档源”链接。

--toc-条目-反向链接
从节标题链接到 TOC 条目。 （默认）

--toc-top-反向链接
从节标题链接到 TOC 的顶部。

--no-toc-反向链接
禁用指向目录的反向链接。

--footnote-反向链接
从脚注/引文链接到参考文献。 （默认）

--无脚注反向链接
禁用脚注和引文的反向链接。

--部分编号
通过 Docutils 启用部分编号。 （默认）

--无节编号
通过 Docutils 禁用节编号。

--条评论
从文档树中删除注释元素。

- 留言
在文档树中留下评论元素。 （默认）

--strip-elements-with-class=
删除所有带有 classes=" 的元素"来自文档树。警告：
有潜在危险； 谨慎使用。 （多用途选项。）

--条类=
删除所有类=" " 来自文档树中元素的属性。
警告：有潜在危险； 谨慎使用。 （多用途选项。）

--报告=, -r
报告系统消息等于或高于：“信息”或“1”，“警告”/“2”
（默认）、“错误”/“3”、“严重”/“4”、“无”/“5”

--详细, -v
报告所有系统消息。 （与“--report=1”相同。）

- 安静的, -q
报告没有系统消息。 （与“--report=5”相同。）

--暂停=
在系统消息处或以上停止执行. 级别如--report。
默认值：4（严重）。

- 严格的
遇到最轻微的问题就停下来。 与“--halt=info”相同。

--退出状态=
为非暂停系统消息启用非零退出状态.
默认值：5（禁用）。

-调试
启用调试级系统消息和诊断。

--无调试
禁用调试输出。 （默认）

--警告=
将系统消息的输出发送到.

- 追溯
当 Docutils 停止时启用 Python 回溯。

--无追溯
禁用 Python 回溯。 （默认）

--输入编码=, -i
指定输入文本的编码和可选的错误处理程序。 默认：
：严格的。

--输入编码错误处理程序=输入_编码_错误_处理程序
为不可解码的字符指定错误处理程序。 选择：“严格”（默认），
“忽略”和“替换”。

--输出编码=, -o
指定文本编码和可选的输出错误处理程序。 默认：
UTF-8：严格。

--输出编码错误处理程序=OUTPUT_ENCODING_ERROR_HANDLER
为不可编码的输出字符指定错误处理程序； “严格”（默认），
“忽略”、“替换”、“xmlcharrefreplace”、“反斜杠替换”。

--错误编码=, -e
为错误输出指定文本编码和错误处理程序。 默认：
ascii：反斜杠替换。

--错误编码错误处理程序=ERROR_ENCODING_ERROR_HANDLER
为错误输出中的不可编码字符指定错误处理程序。 默认：
反斜杠替换。

--语言=, -l
指定语言（如 BCP 47 语言标签）。 默认值：en。

--记录依赖=
将输出文件依赖项写入.

--配置=
从中读取配置设置，如果存在。

- 版, -V
显示该程序的版本号并退出。

- 帮帮我, -h
显示此帮助消息并退出。

PEP 读者 附加选项 默认值
--pep-references 和 --rfc-references 选项（用于 reStructuredText 解析器）打开
默认情况下。

reStructuredText的 分析器 可选项
--pep-参考
识别并链接到独立的 PEP 参考文献（如“PEP 258”）。

--pep-base-url=
PEP 引用的基本 URL（默认“http://www.python.org/dev/peps/“）。

--pep-文件-url-模板=
URL 的 PEP 文件部分的模板。 （默认“pep-%04d”）

--rfc-参考
识别并链接到独立的 RFC 参考（如“RFC 822”）。

--rfc-base-url=
RFC 参考的基本 URL（默认“http://www.faqs.org/rfcs/“）。

--tab-宽度=
设置制表符扩展的空格数（默认为 8）。

--修剪脚注参考空间
删除脚注引用前的空格。

--离开脚注参考空间
在脚注引用之前留下空格。

--无文件插入
禁用插入外部文件内容的指令（“include”和“raw”）；
替换为“警告”系统消息。

--文件插入启用
启用插入外部文件内容的指令（“include”和“raw”）。
默认启用。

——不生
禁用“原始”指令； 替换为“警告”系统消息。

--raw 启用
启用“原始”指令。 默认启用。

--语法高亮=
为使用 Pygments 解析代码而设置的令牌名称：“long”、“short”或“none”之一（没有
解析）”。默认为“长”。

--智能引号=智能引号
将直引号更改为印刷形式：“是”、“否”之一，
“替代[替代]”（默认为“否”）。

特定于 HTML 的 可选项
--模板=
指定模板文件（UTF-8 编码）。 默认是
"/usr/share/docutils/writers/html4css1/template.txt".

--样式表=
逗号分隔的样式表 URL 列表。 覆盖之前的 --stylesheet 和
--stylesheet-path 设置。

--样式表路径=
逗号分隔的样式表路径列表。 如果匹配，则扩展相对路径
文件位于 --stylesheet-dirs 中。 使用--link-stylesheet，路径是
相对于输出 HTML 文件重写。 默认值：“html4css1.css”

--嵌入样式表
在输出 HTML 文件中嵌入样式表。 样式表文件必须是
加工过程中可访问。 这是默认设置。

--链接样式表
链接到输出 HTML 文件中的样式表。 默认值：嵌入样式表。

--样式表目录=
找到样式表的以逗号分隔的目录列表。 使用人
--stylesheet-path 扩展相对路径参数时。 默认： ”['。'，
'docutils/writers/html4css1']"

--初始标头级别=
指定初始标题级别。 “的默认值为 1 ”。不影响
文档标题和副标题（见 --no-doc-title）。

--字段名称限制=
指定一列字段名称的最大宽度（以字符为单位）。 更长
字段名称将跨越用于呈现字段列表的表的整行。
默认值为 14 个字符。 使用 0 表示“无限制”。

--选项限制=
指定选项列表中选项的最大宽度（以字符为单位）。 更长
options 将跨越用于呈现选项列表的整行表格。
默认值为 14 个字符。 使用 0 表示“无限制”。

--脚注参考=
脚注引用格式：“上标”或“括号”之一。 默认是
“括号”。

--归因=
块引用属性的格式：“破折号”之一（长破折号前缀），
“括号”/“括号”，或“无”。 默认为“破折号”。

--紧凑列表
删除“简单”项目符号列表和项目之间的额外垂直空白
枚举列表。 默认值：启用。

--无紧凑列表
禁用紧凑的简单项目符号和枚举列表。

--紧凑字段列表
删除简单字段列表项之间的额外垂直空白。 默认：
启用。

--无紧凑字段列表
禁用紧凑的简单字段列表。

--表格样式=表格样式
添加到标准表类。 定义的样式：“无边界”。 默认： ””

--数学输出=数学输出
数学输出格式，“MathML”、“HTML”、“MathJax”或“LaTeX”之一。 默认值：“HTML
数学.css”

--no-xml-声明
省略 XML 声明。 谨慎使用。

--cloak-电子邮件地址
混淆电子邮件地址以混淆收割机，同时仍保留电子邮件链接
可用于符合标准的浏览器。

PEP/HTML 特定 可选项
对于 PEP/HTML 编写器，--stylesheet-path 选项的默认值是
"/usr/share/docutils/writers/pep_html/pep.css"，并且 --template 的默认值是
"/usr/share/docutils/writers/pep_html/template.txt"。请参阅上面的 HTML 特定选项。

--python-家=
Python 的主页 URL。 默认为“http://www.python.org".

--pep-home=
PEP 的主页 URL 前缀。 默认为“.” （当前目录）。

构建-HTML 可选项
--递归
递归扫描子目录以查找要处理的文件。 这是默认设置。

- 当地的
不要扫描子目录以查找要处理的文件。

--修剪=
不处理文件（外壳通配模式，用冒号分隔）。
可以多次使用此选项来指定多个目录。 默认：
“.hg:.bzr:.git:.svn:CVS”。

--忽略=
递归忽略匹配任何给定通配符的文件（shell globbing）
模式（以冒号分隔）。

- 沉默的
静默工作（无进度消息）。 独立于“--quiet”。

--试运行
不处理文件，显示将被处理的文件。

RST-构建HTML(1)

使用 onworks.net 服务在线使用 rst-buildhtml