配置
这个配置目录必须包含名为的文件conf.py公司.这个文件（包含Python代码）被称为“构建配置文件”并包含（几乎）定制Sphinx输入所需的所有配置和输出行为。
可选文件docutils.conf文件可以添加到配置中要调整的目录Docutils公司配置（如果未被覆盖）或由狮身人面像拍摄。
配置文件在构建时作为Python代码执行（使用importlib.import_module（），并将当前目录设置为其包含目录），因此可以执行任意复杂的代码。然后，Sphinx从文件的名称空间读取简单名称作为其配置。
需要注意的要点：
如果没有其他文档记录，值必须是字符串，其默认值为空字符串。
术语“完全限定名”是指命名可导入的模块内的Python对象；例如，FQN“sphinx.builders.Builder”是指建设者中的类狮身人面像建筑商模块。
请记住，文档名称使用/作为路径分隔符，而不是包含文件扩展名。
自conf.py公司作为Python文件读取，通常的规则适用于编码和Unicode支持。
配置名称空间的内容经过pickle处理（以便Sphinx可以找到配置更改时），因此它可能不包含不可选取的值–使用从命名空间中删除它们德尔如果合适的话。模块包括自动删除，因此您无需德尔使用后您的进口产品。
有一个名为标签在配置文件中可用。它可以用于查询和更改标记（请参见包括基于标记的内容). 使用tags.has（'tag'）要查询，tags.add（“标记”）和tags.remove（“标记”）以进行更改。仅通过设置标签-t吨命令行选项或通过tags.add（“标记”）可以使用查询tags.has（'tag'）.请注意，当前生成器标记在中不可用conf.py公司，因为它是创建之后生成器已初始化。
一般配置
-
扩展
作为模块名称的字符串列表扩展这些可以是Sphinx（命名为狮身人面像扩展*)或定制。
请注意，您可以扩展搜索路径如果您的扩展位于另一个目录中&但请确保使用绝对路径。如果扩展路径相对于配置目录，使用os.path.abspath（）如此：
进口 系统， 操作系统
系统.路径.追加(操作系统.路径.吸收路径(“sphinxext”))
扩展 = [“extname”]
这样，您可以加载名为外部名称从子目录狮身人面像.
配置文件本身可以是扩展名；为此，你只需要提供设置（）功能。
-
源后缀
源文件的文件扩展名。斯芬克斯考虑了这个文件后缀作为来源。该值可以是字典映射文件扩展名到文件类型。例如：
源修补程序 = {
“.rst”: '重组文本'，
“.txt”: '重组文本'，
“.md”: '降价'，
}
默认情况下，Sphinx仅支持'重组文本'文件类型。你可以使用源解析器扩展添加新的文件类型。请阅读文档以了解扩展名支持的文件类型。
该值还可以是文件扩展名列表：那么Sphinx将考虑它们都映射到'重组文本'文件类型。
默认值为{“.rst”： '重组文本'}.
注释
文件扩展名必须以点开始（例如。.rst（第一个）).
-
源代码（_E）
所有reST源文件的编码。建议的编码，以及默认值为“utf-8-sig”.
在版本0.5中添加：此前，狮身人面像只接受UTF-8编码源。
-
源处理器（_P）
如果给定，那么为不同的源提供一个解析器类的字典就足够了。这个键是后缀，值可以是类或字符串解析程序类的完全限定名称。解析器类可以是docutils.parsers。分析程序或sphinx.parsers。分析器。带有字典中不存在的后缀将使用默认值进行分析reStructuredText解析器。
例如：
源处理器（_P） = {“.md”: '推荐标记.parser。CommonMarkParser'}
注释
请参阅降价有关使用降价的详细信息与狮身人面像。
-
主文档
等同于root_doc（根文件）.
在版本4.0中更改：已重命名主文档到root_doc（根文件）.
-
root_doc（根文件）
“根”文档的文档名称，即包含根目录树指令。默认值为'索引'.
在版本2.0中更改：默认值更改为'索引'从'内容'.
在版本4.0中更改：已重命名root_doc（根文件）从主文档.
-
排除_模式
球形图案列表在查找时应排除源文件。它们与相对的源文件名相匹配到源目录，使用斜杠作为所有平台。
示例图案：
排除_模式查找静态文件时也会参考在里面html静态路径和html_extra路径.
-
包含模式（_P）
球形图案列表用于查找源文件的。他们与相对于源目录的源文件名相匹配，在所有平台上使用斜杠作为目录分隔符。默认值为**，这意味着所有文件都是从源目录中递归包含的。排除_模式优先于包含模式（_P）.
示例图案：
-
模板_路径
包含额外模板（或覆盖模板）的路径列表内置/主题特定模板）。相对路径被视为相对于配置目录。
在版本1.3中更改：由于这些文件不是要构建的，因此会自动添加到排除_模式.
-
模板_桥
具有可调用（或简单的类）的完全限定名的字符串返回的实例模板桥.然后，这个实例被用来呈现HTML文档，可能还有输出其他构建器（当前为更改构建器）。（请注意，模板如果要使用HTML主题，则必须使桥具有主题意识。）
-
rst_epilog（第一个）
将包含在每个源末尾的reStructuredText字符串读取的文件。这是一个可能添加替换的地方，应该在每个文件中都可用（另一个是rst_角色日志). 安例子：
rst_epilog（第一个） = """
..|psf|replace:：Python软件基金会
"""
-
rst_角色日志
将在每个读取的源文件。这是一个可能添加替换的位置应在每个文件中可用（另一个是rst_epilog（第一个）). 安例子：
rst_角色日志 = """
..|psf|replace:：Python软件基金会
"""
-
主域
默认值的名称领域.也可以是无禁用默认域。默认值为“py”.其他域中的对象（无论域名是否明确给定，或由默认域指令）将具有域name在命名时显式地添加在前面（例如，当默认域为C时，Python函数将被命名为“Python-function”，而不仅仅是“function”）。
-
默认角色（_R）
要用作默认值的reST角色（内置或Sphinx扩展）的名称角色，即标记的文本`像 这个`。可以将其设置为“py:obj”制造`过滤器`Python函数的交叉引用“过滤器”。默认值为无，不会重新分配默认角色。
始终可以使用标准reST默认role指令。
-
keep_warnings（保持警告）
如果为true，则在构建的文件。无论此设置如何，警告始终写入标准错误流，当狮身人面像建造正在运行。
默认值为False（错误），0.5之前的行为是始终保留它们。
-
显示警告类型
如果真的，每个警告的类型作为后缀添加到警告消息中，例如。，警告： [...] [索引]或警告： [...] [目录循环].默认值为False（错误）.
-
suppress_warnings（禁止警告）
禁止任意警告消息的警告类型列表。
Sphinx内核支持以下警告类型：
应用程序地址节点
应用程序地址指示
应用程序地址角色
应用程序添加通用角色
应用程序地址源地址
配置缓存
下载.not_readable
epub.未知_项目文件
epub.复制的_文档_条目
i18n.参考不一致
指数
图像不可读
参考术语
参考参考
参考号参考号
参考关键字
参考选项
参考信号
参考脚注
参考.doc
参考号：python
其他突出显示故障
toc.圆形
不包括toc.excluded
toc.not_readable（不可读）
toc.secnum公司
扩展还可以定义自己的警告类型。由第一方定义的狮身人面像.ext扩展包括：
自动文档
autodoc.import_object
自动分节标签<文件 名称>
自动摘要
中间外部
你可以从这些类型中选择。你也可以只给第一个组件以排除附加到它的所有警告。
在1.5.1版中进行了更改：补充epub.未知_项目文件
版本2.1中的更改：补充自动分节标签<文件 名称>
3.3.0版中的更改：补充epub.复制的_文档_条目
在版本4.3中更改：补充不包括toc.excluded和toc.not_readable（不可读）
-
需求_狮身人面像
如果设置为少校版本字符串类似'1.1'，斯芬克斯将将其与版本进行比较，如果太旧则拒绝构建。违约没有要求。
-
需要_扩展
此值可以是指定的版本要求的字典中的扩展扩展，例如。需求_扩展 =
{'phinxcontrib.something'： '1.5'}。版本字符串应位于形式少校。不必为所有人指定要求扩展名，仅适用于您要检查的扩展名。
这要求扩展将其版本指定给Sphinx（请参见Sphinx扩展API如何做到这一点）。
-
手册页_url
交叉引用的URL参考页角色。如果是这样定义为https://manpages.debian.org/{路径}，的：手册页：`man（1）`角色将链接到<https://manpages.debian.org/man网址(1)>. 可用的模式有：
第页-手册页(男人)
部分-手册部分(1)
路径-指定的原始手册页面和章节(男子（1）)
这也支持指定为男.1.
注释
这目前只影响HTML编写器，但可能在未来扩大。
-
吹毛求疵
如果属实，斯芬克斯将发出警告全部的目标不能位于的引用找到。默认值为False（错误）。您可以使用临时激活此模式这个-n个命令行开关。
-
挑剔忽略
一组或一列（类型， 目标）元组（默认为空）在“挑剔模式”下生成警告时被忽略。请注意类型应包括域名（如果存在）。示例条目如下（'py:func'， “int”）或（'envvar'， “LD_LIBRARY_PATH”）.
在版本6.2中更改：将允许的容器类型更改为集合、列表或元组
-
挑剔_ignore_regex
的扩展版本挑剔忽略，它反而解释这个类型和目标字符串作为正则表达式。请注意正则表达式必须匹配整个字符串（就像^和$插入标记）。
例如，（r’py:.*’， r'foo.*bar\。B.*’）将忽略挑剔的警告对于以开头的所有python实体“foo”并且有'酒吧。B’在里面它们，例如（'py:const'， 'foo_package.bar。BAZ_价值观’）或（“by:class”， '食物吧。酒吧服务员）.
在版本6.2中更改：已将允许的容器类型更改为集合、列表或元组
-
numfig（数字）
如果为true，则数字、表格和代码块将自动编号有一个标题。这个numref（数字参考）角色已启用。到目前为止，只有HTML和LaTeX构建者遵守。默认值为False（错误）.
注释
无论是否启用此选项，LaTeX构建器始终分配数字或者没有。
-
数字格式
字典映射“数字”，'表'，“代码块”和'节'用于地物编号格式的字符串。作为一个特殊的角色，%秒将替换为图号。
默认为使用'图。 %s’对于“数字”，'表 %s’对于'表'，'列表 %s’对于“代码块”和'节 %s’对于'节'.
-
数字图形深度
如果设置为0、数字、表格和代码块连续编号开始于1.
如果1（默认）数字将为x.1条，x.2条，……与x个截面编号（顶层截面；无x。如果没有节）。这自然仅适用于通过激活节编号的情况这个：编号：的选项目录树指令。
2意味着数字将是x.y.1年，x.y.2年，…如果位于一个子节（但仍然x.1条，x.2条，…如果位于截面和1，2，…如果不在任何顶层部分。）
等等…
-
智能引号
如果为真Docutils Smart Quotes转换，最初基于Smarty长裤（限于英语），目前适用于许多语言，将用于将引号和破折号转换为印刷体正确的实体。默认值：真的.
一个docutils.conf文件位于配置目录中的文件（或全球的~/.docutils文件）无条件遵守停用通过相应的Docutils选项.但是如果是的话激活那么，他们智能引号确实占上风。
-
智能报价_操作
此字符串自定义智能报价转换。查看文件智能报价.py在Docutils存储库了解详细信息。这个违约“qDe”培养正常人q个uote字符"，'，em-和en-D类灰烬---，--、和e（电子）利普斯....
-
智能报价_排除
这是一个字典其默认值为：
{“语言”: [“ja”], “建筑商”: [“男人”， “文本”]}
每个条目都提供了一个足够的条件来忽略智能引号设置和停用智能报价转换。接受的密钥如上所示“建筑商”或'语言'.这些值是列表。
注释
目前，如果调用制作具有多个目标，第一个目标名称是唯一测试的目标名称这个“建筑商”它决定了一切。此外，a制作 文本下列的制作 html格式需要以表格形式发布制作 文本
O=“-E”强制重新传递源文件，就像缓存的文件一样已经改变了。另一方面，问题不会出现在直接使用狮身人面像建造当它缓存时（默认用法）每个构建器位置中的已解析源文件。
提示
有效停用（或自定义）例如，给定生成器的智能引号乳胶，是要使用的制作这种方式：
make latex O=“-D smartquotes_action=”
这可以遵循一些制作 html格式没有问题，与前面注释中的情况。
-
用户代理（_A）
斯芬克斯的用户代理。它用于HTTP访问（例如。linkcheck、intershinx等）。默认值为“狮身人面像/X.Y.Z
请求/X.Y.Z python/X.Y.Z“.
-
tls验证
如果为true，Sphinx将验证服务器认证。默认值为真的.
-
tls _ cacerts（tls _卡塞特）
CA证书文件的路径或目录的路径包含证书。这也允许字典映射将主机名设置为证书文件的路径。这些证书用于验证服务器证书。
提示
狮身人面像使用请求内部作为HTTP库。因此，Sphinx在指向目录请求_ CA _绑定环境变量，如果tls _ cacerts（tls _卡塞特）未设置。
-
今天
-
今天（_fmt）
这些值确定如何设置当前日期的格式替换|今天|.
默认值是现在今天和a今天（_fmt）属于“%b” %d中，
%是的'（或者，如果使用启用了翻译语言，相当于所选区域设置的格式）。
-
高亮显示语言
突出显示源代码的默认语言。默认为“默认”。它类似于“python3”; 它主要是一个超集“蟒蛇”但它回落到“无”如果失败，则不发出警告。“python3”如果失败，其他语言将发出警告。
该值应该是有效的Pygments lexer名称，请参见显示代码示例了解更多详细信息。
在版本1.4中更改：默认值是现在“默认”。如果您只喜欢Python 2高亮显示，您可以将其设置回“蟒蛇”.
-
突出显示选项（_O）
将语言名称映射到lexer模块选项的字典Pygments公司。这些是特定于lexer的；对于每个人理解的选项，请参阅Pygments文档.
例子：
突出显示选项（_O） = {
“默认”: {“stripall”: 真的},
“php”: {“startinline”: 真的},
}
也允许使用单个选项字典。然后它被识别作为指定的lexer的选项突出显示语言:
#“highlight_language”的配置``
突出显示选项（_O） = {“stripall”: 真的}
-
pygments_style（复制样式）
用于Pygments突出显示源代码的样式名称。如果未设置，主题的默认样式或“狮身人面像”已选择用于HTML输出。
在版本0.3中更改：如果该值是自定义Pygments样式类的完全限定名称，然后将其用作自定义样式。
-
最大签名线长度
如果签名的字符长度超过设置的数字签名中的参数将显示在单个逻辑行。
什么时候？无（默认设置），没有最大长度签名将显示在单个逻辑行上。
“逻辑线”类似于硬线突破或主题选择“软包装”单个逻辑行，此设置不影响这种行为。
域可以提供选项来禁止对个人进行任何硬包装对象指令，如在C、C++和Python域（例如。py:函数：单行参数列表).
-
添加函数父类
一个布尔值，用于决定是否将括号附加到函数和方法角色文本（例如：func:`输入`)以表明name是可调用的。默认值为真的.
-
添加模块名称
一个布尔值，用于决定是否将模块名称前置到所有对象名称（用于对象类型，其中某种“模块”是定义），例如py：函数指令。默认值为真的.
-
toc_object_entries（对象条目）
为域对象（例如函数、类、，属性等）。默认值为真的.
-
toc对象条目显示父项
一个字符串，用于确定域对象（例如函数、类、，属性等）显示在其目录条目中。
使用领域以允许域确定适当数量的父母来展示。例如，Python域将显示类.method（）和函数（），忽略了模块。父母级别。这是默认设置。
使用隐藏只显示元素的名称而不显示任何父元素（即。方法（）).
使用全部的显示对象的完全限定名（即。模块。类.method（）)，显示所有父项。
-
显示作者（_A）
决定是否共同作者和章节作者指令在生成的文件中生成任何输出。
-
修改索引通用前缀
排序Python模块索引时忽略的前缀列表（例如，如果设置为[“oo.”]，然后foo.bar按钮如下所示B类，不F类). 如果您将包含单个包装。目前仅适用于HTML生成器。默认值为[].
删去reST所需的脚注引用前的空格解析器识别脚注，但在输出中看起来不太好。
-
修剪十进制标志
如果为true，则doctest标记（注释如下# 文档测试： 旗帜， ...)在线条末端和<空白行>删除所有代码的标记显示交互式Python会话（即doctest）的块。默认值为真的。请参阅扩展文档测试了解更多包含文档测试的可能性。
-
条带_签名_反斜杠
默认值为False（错误）.启用反斜杠反斜杠后\\在一个域指令将更改为\，甚至在字符串文本中。这是3.0版之前的行为，将此变量设置为真的将恢复这种行为。
-
选项_强调_占位符
默认值为False（错误）.启用时，强调中的占位符选项指令。若要显示文字大括号，请使用反斜杠转义(\{). 例如，option_emphasise_placeholders=真和。。 选项：： -foption={TYPE}将使用渲染类型强调。
国际化选项
这些选项会影响狮身人面像母语支持。请参阅文档国际化了解详细信息。
-
语言
文档所用语言的代码。任何文本自动斯芬克斯将使用该语言生成。此外，斯芬克斯将尝试用译文替换文档中的单个段落从中获得的集合语言环境目录斯芬克斯将搜索特定语言的数字由命名图形语言文件名（例如，德语版我的图片.png将我的图片.de.png默认设置）并将其替换为原始图形。在LaTeX生成器，将选择合适的语言作为巴别塔包裹。默认值为“恩”.
Sphinx目前支持的语言有：
应收账–阿拉伯语
背景–保加利亚语
十亿–孟加拉语
加利福尼亚州–加泰罗尼亚语
结块–卡奇克尔
反恐精英–捷克语
塞浦路斯–威尔士语
数据采集–丹麦语
判定元件–德语
埃尔–希腊语
英语–英语（默认）
电子操作系统–世界语
锿–西班牙语
et（等）–爱沙尼亚语
欧盟–巴斯克语
法–伊朗
菲–芬兰语
前–法语
他–希伯来语
你好–印地语
hi_IN（_I）-印地语（印度）
小时–克罗地亚语
胡–匈牙利语
身份证件–印尼语
它–意大利语
青年成就组织–日语
科–韩语
书信电报–立陶宛语
lv（低压）–拉脱维亚语
百万–马其顿语
nb_否–挪威博克马尔语
氖–尼泊尔语
荷兰–荷兰语
公共图书馆–波兰语
磅–葡萄牙语
pt_BR（pt_BR）–巴西葡萄牙语
打印_打印–欧洲葡萄牙语
反渗透–罗马尼亚语
俄罗斯–俄语
硅–僧伽罗
sk公司–斯洛伐克语
sl（sl）–斯洛文尼亚语
平方–阿尔巴尼亚语
锶–塞尔维亚语
sr@拉丁语–塞尔维亚语（拉丁语）
服务器_RS–塞尔维亚语（西里尔文）
sv公司–瑞典语
助教–泰米尔语
特–泰卢固语
信托收据–土耳其语
英国_UA–乌克兰语
乌尔–乌尔都语
不及物动词–越南语
zh_CN（中文）–简体中文
zh_TW（日文）–繁体中文
-
语言环境目录
-
要在其中搜索其他邮件目录的目录（请参阅语言)，相对于源目录。上的目录此路径由标准搜索获取文本模块。
从的文本域获取内部消息狮身人面像; 所以如果你添加目录./语言环境对于此设置，消息目录（编译自.po型格式使用消息fmt)必须在中./语言环境/语言/LC_MESSAGES/狮身人面像。的文本域单个文档取决于获取文本压缩.
默认值为[“位置”].
-
gettext_allow_fuzzy_translations（获取文本允许模糊翻译）
如果为true，则使用消息目录中的“模糊”消息进行翻译。默认值为False（错误）.
-
获取文本压缩
-
如果为true，则文档的文本域是其顶级文档的docname项目文件及其基本目录。
如果设置为string，则所有文档的文本域都是此字符串文档使用单个文本域。
默认情况下，文档标记/代码.rst最终在标记文本域。将此选项设置为False（错误），是的标记/代码.
-
获取文本uuid
如果为true，Sphinx将生成uuid信息，用于消息中的版本跟踪目录。它用于：
如果您想加速计算，可以使用python-levenshtein巨蟒使用C编写的第三方程序包pip安装python-levenshtein.
默认值为False（错误）.
-
gettext_位置
如果为true，Sphinx将为消息中的消息生成位置信息目录。
默认值为真的.
-
gettext自动生成
如果为true，Sphinx将为每个翻译目录文件构建mo文件。
默认值为真的.
-
gettext附加目标
指定名称以启用gettext提取和翻译应用i18n另外。您可以指定以下名称：
- 索引:
索引项
- 文字块:
文字块(::注释和码块指令）
- 文档测试块:
doctest块
- 原始:
原始含量
- 图像:
图像/图形uri
例如：gettext附加目标 = ['literal-block'， “图像”].
默认值为[].
在4.0版中更改：默认情况下，转换图像的替换文本。
-
图形语言文件名
特定于语言的图形的文件名格式。默认值为{root}。{语言}{扩展}。它将扩展到目录名/文件名.en.png从。。 图像：： 目录名/文件名.png.可用的格式标记有：
{根}-文件名，包括任何路径组件，不包括文件扩展，例如。目录名/文件名
{路径}-文件名的目录路径组件，后面有一个如果非空，请使用斜线，例如。目录名/
{文档路径}-当前文档的目录路径组件，带有如果非空，则为尾部斜杠。
{基本名称}-不带目录路径或文件扩展名的文件名组件，例如。文件名
{扩展}-文件扩展名，例如。.png码
{语言}-翻译语言，例如。英语
例如，将此设置为{path}{language}/{basename}{ext}将展开到目录名/en/filename.png而不是。
在版本1.5中进行了更改：补充{路径}和｛基本名称｝代币。
-
翻译进程类
控制添加哪些类（如果有）以指示翻译进度。此设置可能仅由文档翻译人员使用，以便快速显示已翻译和未翻译的内容。
默认为False（错误）.
数学选项
这些选项会影响数学符号。
-
math_number_all（数学_数字_全部）
将此选项设置为真的如果您希望对所有显示的数学进行编号。默认值为False（错误）.
-
math_eqref_格式
用于格式化公式引用标签的字符串。这个{数字}place-holder代表方程式编号。
例子：'等式。{数字}'例如，呈现为，等式10.
-
math_numfig
如果真的，当数字已启用。这个数字_秒数_深度设置受到尊重。这个等式，不是numref（数字参考），角色必须用于引用方程式编号。默认值为真的.
HTML输出选项
这些选项影响HTML、HTML帮助输出和其他生成器使用Sphinx的HTMLWriter类。
-
html_主题
HTML输出应该使用的“主题”。请参阅关于的部分主题。默认值为“雪花石膏”.
-
html_主题_选项
影响选定对象外观的选项字典主题。这些是特定于主题的。对于内置程序理解的选项主题，请参见这个部分.
-
html_theme_path
包含自定义主题的路径列表，可以作为子目录，也可以作为zip文件。相对路径被视为相对于配置目录。
-
html样式
用于HTML页面的样式表。必须存在同名文件要么是狮身人面像静态/路径，或在给定的自定义路径之一中在里面html_静态路径。默认值是选定的主题。如果您只想添加或覆盖一些比较在主题的样式表中，使用CSS@导入导入主题的样式表。
-
html_标题
使用Sphinx自己的模板生成的HTML文档的“标题”。这被附加到<标题>单个页面的标记，用于导航栏作为“最顶层”元素。默认为'<项目>
v（v）<修订版> 文档'.
-
html短标题
HTML文档的较短“标题”。这用于中的链接标题和HTML帮助文档中的。如果未给定，则默认为html_标题.
-
html_基本URL
指向HTML文档根的基本URL。它被使用了使用指示文档位置标准链接关系.违约：“”.
-
html_codeblock_linenos_样式
代码块的行号样式。
'表格'–使用显示行号<表格>标签
“内联”–使用显示行号<span>标记（默认）
-
html_上下文
要传递到模板引擎上下文中的所有值的字典页。也可以使用-A类命令行选项狮身人面像建造.
-
html_logo
如果给定，这必须是图像文件的名称（相对于配置目录)这是文档的徽标或URL指向徽标的图像文件。它位于侧边栏的顶部；因此，其宽度不应超过200像素。违约：无.
在版本0.4.1中添加：图像文件将复制到_静态输出的目录HTML，但仅当文件不存在时。
-
html_飞行控制
如果给定，这必须是图像文件的名称（相对于配置目录)这是文档的收藏夹，或者是指向favicon的图像文件。现代浏览器使用此作为图标用于选项卡、窗口和书签。它应该是Windows样式的图标文件(.ico图标)，大小为16x16或32x32像素。默认值：无.
在版本0.4中添加：图像文件将复制到_静态输出的目录HTML，但仅当文件不存在时。
在版本4.0中更改：还接受favicon的URL。
-
html_css_文件
CSS文件列表。条目必须是文件名字符串或元组包含文件名字符串和属性字典。这个文件名必须相对于html静态路径，或完整URI有类似方案https://example.org/style.css网址. The属性已使用对于的属性<链接>标签。它默认为空列表。
例子：
html_css_文件 = ['自定义.css'，
'https://example.com/css/custom.css'，
('打印.css'， {“媒体”: “打印”})]
作为一种特殊属性，优先可以设置为整数以加载CSS提前或延迟提交。有关更多信息，请参阅狮身人面像.add_css_file（）.
-
html_js_文件
JavaScript列表文件名。条目必须是文件名字符串或包含文件名字符串和属性字典。这个文件名必须相对于html静态路径，或完整具有类似方案的URIhttps://example.org/script.js. The属性是用于的属性<脚本>标签。它默认为空列表。
例子：
html_js_文件 = ['脚本.js'，
'https://example.com/scripts/custom.js'，
('自定义.js'， {“异步”: “异步”})]
作为一种特殊属性，优先可以设置为整数以加载更早或更慢步骤的JavaScript文件。有关更多信息，请参阅狮身人面像.add_js_file（）.
-
html静态路径
包含自定义静态文件的路径列表（例如样式工作表或脚本文件）。相对路径被视为相对于配置目录。它们被复制到输出_静态目录位于主题的静态文件之后，因此文件命名默认.css将覆盖主题的默认.css.
由于这些文件不是要构建的，因此会自动排除它们来自源文件。
注释
出于安全原因，dotfiles位于html静态路径将不被复制。如果您有意复制，请将每个文件路径添加到此设置：
html静态路径 = ['静态（_S）'， '静态/.htaccess（_S）']
另一种方法是，您还可以使用html_extra路径。它允许将点文件复制到目录。
包含与不直接相关的额外文件的路径列表文档，例如robots.txt（机器人.txt）或.ht访问.相对路径被视为相对于配置目录。它们被复制到输出目录。他们会的覆盖任何同名的现有文件。
由于这些文件不是要构建的，因此会自动排除它们来自源文件。
在版本1.4中更改：额外目录中的点文件将复制到输出目录。它指的是排除_模式关于额外复制文件和目录，并忽略路径是否与模式匹配。
-
html最新更新的fmt
如果不是None，则插入“Last updated on：”时间戳在每个页面底部，使用给定的strftime（）格式。空字符串等效于“%b” %日期：， %是的'（或a取决于地区的等效项）。
-
html_use_stry裤子
如果为true，引号和破折号将转换为正确的排版实体。违约：真的.
自1.6版以来已弃用：要禁用智能引号，请使用智能引号.
-
html_永久链接
为每个标题和描述环境添加链接定位。违约：真的.
-
html_永久链接_图标
每个标题和描述环境的链接锚点的文本。允许使用HTML实体和Unicode。默认值：段落符号；¶
自定义侧边栏模板，必须是一个将文档名称映射到模板名称。
键可以包含全局样式模式，在这种情况下，所有匹配文档将获得指定的侧栏。（当多个全局样式模式匹配任何文档。）
这些值可以是列表或单个字符串。
如果值是一个列表，则它指定侧边栏模板的完整列表包括在内。如果要包括所有或部分默认侧边栏，他们也必须列入这份清单。
默认侧栏（用于不匹配任何模式的文档）为由主题本身定义。内置主题使用这些模板违约：['localtoc.html'， '关系.html'， '源链接.html'，
'searchbox.html'].
如果值是单个字符串，则指定要添加的自定义侧边栏在'源链接.html'和'搜索框.html'条目。这个用于与1.0之前的Sphinx版本兼容。
自版本1.7以来已弃用：的单个字符串值html_侧栏将在2.0中删除
可以呈现的内置侧栏模板包括：
例子：
html_侧栏 = {
'**': ['globaltoc.html'， '源链接.html'， '搜索框.html'],
'使用/windows': [“windowssidebar.html”， '搜索框.html'],
}
这将呈现自定义模板windowssidebar.html窗口和快速搜索给定文档侧栏中的框，并呈现默认值所有其他页面的侧栏（除了本地TOC被替换为全球TOC）。
在版本1.0中添加：能够使用全局键并指定多个侧边栏。
请注意，只有当所选主题不具有边栏，就像内置的卷轴和俳句主题。
-
html_附加页面
应该呈现到HTML页面的其他模板必须是将文档名称映射到模板名称的字典。
例子：
html_附加页面 = {
'下载': '自定义下载.html'，
}
这将呈现模板自定义下载.html作为页面下载.html.
-
html域索引
如果为true，则除生成一般索引外，还生成特定于域的索引。例如，对于Python域，这是全局模块索引。默认值为真的.
该值可以是一个布尔值，也可以是应生成的索引名列表。要找出特定索引的索引名，请查看HTML文件名。例如，Python模块索引的名称为“py-modindex”.
-
html使用索引
如果为true，请为HTML文档添加索引。默认值为真的.
-
html拆分索引
如果为true，则生成两次索引：一次作为一个页面条目，每个起始字母一页。默认值为False（错误）.
-
html_copy源
如果为true，则在HTML构建中包含reST源_来源/名称。默认值为真的.
-
html显示源链接
如果为true（并且html_copy源也是true），链接到reST源将添加到侧边栏。默认值为真的.
-
html源链接后缀
要附加到源链接的后缀（请参见html显示源链接),除非他们已经有了这个后缀。默认值为“.txt”.
-
html_use_opensearch公司
如果不是空的，则为打开搜索将输出描述文件，并且所有页面都将包含<链接>引用它的标签。由于OpenSearch不支持它的搜索页面位置，则此选项的值必须是基本URL从中提供这些文件（没有尾部斜杠），例如。"https://docs.python.org"。默认值为“”.
-
html文件后缀
如果设置为字符串值。如果保留为默认值无，后缀为“.html”.
-
html_链接_后缀
生成的HTML文件链接的后缀。默认值为whateverhtml文件后缀设置为；可以进行不同的设置（例如支持不同的web服务器设置）。
-
html显示版权
如果为true，HTML页脚中会显示“（C）版权…”。默认值为真的.
-
html显示搜索摘要
如果为true，则关键字周围的文本显示为每个搜索结果的摘要。默认值为真的.
-
html_show_sphinx公司
如果为true，HTML页脚中会显示“Created using Sphinx”（使用狮身人面像创建）。默认值为真的.
-
html_输出_编码
HTML输出文件的编码。默认值为'utf-8'。请注意编码名称必须是有效的Python编码名称和有效的HTML字符集值。
-
html压缩列表
如果为true，则列出所有项目由单个段落和/或子列表所有其项等（递归定义）将不使用<p>元素。这是标准的docutils行为。违约：真的.
-
html_secnumber后缀
节编号的后缀。违约：". "。设置为" "抑制节号上的最后一个点。
-
html搜索语言
用于生成HTML全文搜索索引的语言。这个默认为使用选定的全局语言语言.如果有不支持此语言，“en”（英语）用于选择英语语言。
支持这些语言：
数据采集–丹麦语
荷兰–荷兰语
英语–英语
菲–芬兰语
前–法语
判定元件–德语
胡–匈牙利语
它–意大利语
青年成就组织–日语
不–挪威语
磅–葡萄牙语
反渗透–罗马尼亚语
俄罗斯–俄语
锿–西班牙语
sv公司–瑞典语
信托收据–土耳其语
zh（德国）–中文
加快构建速度
每种语言（日语除外）都提供自己的词干算法。默认情况下，Sphinx使用Python实现。你可以用C实现来加速构建索引文件。
-
html搜索选项
带有搜索语言支持选项的字典，默认为空。这些选项的含义取决于所选的语言。
英语支持没有选择。
日本支持有以下选项：
- 类型:
类型是虚线模块路径字符串，用于指定Splitter实现应该从狮身人面像搜索.ja。基极拆分器.如果未指定或无已指定，'狮身人面像搜索.ja。默认拆分器'将使用。
您可以从这些模块中进行选择：
- '狮身人面像搜索.ja。默认拆分器':
TinySegmer算法。这是默认拆分器。
- '狮身人面像搜索.ja。MecabSplitter（机械分离器）:
MeCab绑定。要使用此拆分器，请使用“mecab”python绑定或动态链接库（linux为'ibmecab.so'，windows为'libmecab.dll'）是必修的。
- '狮身人面像搜索.ja。JanomeSplitter':
Janome绑定。要使用此拆分器，真善美是必需的。
自1.6版以来已弃用：“mecab”，“珍妮”和“默认”已弃用。为了保持兼容性，“mecab”，“珍妮”和“默认”是也可以接受。
其他选项值取决于您选择的拆分器值。
- 的选项
“mecab”:
- dic_enc（&N）:
dic_enc选项是MeCab算法的编码。
- 字典:
dict选项是用于MeCab算法的字典。
- 图书馆:
lib选项是用于通过查找MeCab库的库名称如果未安装Python绑定，则返回ctypes。
例如：
html搜索选项 = {
“类型”: “mecab”，
“dic_enc”: 'utf-8'，
“dict”: '/path/to/mecab.dic'，
“库”: '/path/to/libmecab.so'，
}
- 的选项
“珍妮”:
- 用户_签名:
user_dic选项是Janome的用户词典文件路径。
- 用户_输入_输入:
user_dic_enc选项是用户词典文件的编码由指定用户_签名选项。默认值为“utf8”。
在版本1.4中更改：重新组织日语的html_search_options和任何自定义拆分器可由使用类型设置。
中方支持有以下选项：
-
html搜索核心
JavaScript文件的名称（相对于配置目录）实现搜索结果记分器。如果为空，则使用默认值。
计分员必须实现以下接口，并且可以选择定义记分（）功能实现更精细的控制。
常数 记分员 = {
//实现以下功能以进一步调整每个结果的分数
分数: 结果 => {
常数 [文档名称， 标题， 锚， 描述， 分数， 文件名] = 结果
// ... 计算新分数。。。
返回 分数
},
//查询匹配对象的全名
对象名称匹配: 11，
//或匹配对象名称的最后一个虚线部分
对象部分匹配: 6，
//相加分数取决于对象的优先级
对象优先级: {
0: 15， //过去是重要的结果
1: 5， //曾经是对象结果
2: -5， //过去是不重要的结果
},
//当优先级不在映射中时使用。
对象优先默认值: 0，
//在标题中找到查询
标题: 15，
部分标题: 7，
//在术语中找到的查询
学期: 5，
部分条款: 2，
};
-
html缩放图像链接
如果为true，则图像本身链接到原始图像（如果没有）“target”选项或与缩放相关的选项：“scale”、“width”、“height”。默认值为真的.
文档作者可以手动禁用此功能无标度链接类到图像：
。。 形象::狮身人面像.png：比例：50%：类别：无标度链接
-
html路径渲染器
HTML输出的math_renderer扩展名。默认值为“mathjax”.
-
html_实验_html5_编写器
使用HTML5编写器处理输出。默认值为False（错误）.
-
html4_写入程序
输出是用HTML4编写器处理的。默认值为False（错误）.
单个HTML输出选项
自定义侧边栏模板，必须是将文档名称映射到的字典模板名称。它只允许一个名为'索引'.所有其他键被忽略。有关更多信息，请参阅html_侧栏.签署人默认，它与html_侧栏.
HTML帮助输出选项
-
htmlhelp_base名称
HTML帮助生成器的输出文件基名称。默认值为“pydoc”.
-
html帮助文件后缀
这是生成的HTML帮助文件的文件名后缀。这个默认值为“.html”.
-
htmlhelp_link_suffix
生成的HTML文件链接的后缀。默认值为“.html”.
Apple帮助输出选项
这些选项会影响Apple帮助输出。此生成器派生自HTML生成器，因此HTML选项也适用于适当的地方。
注释
Apple Help输出仅适用于Mac OS X 10.6及更高版本，因为需要希乌提和共同设计命令行工具，两者都不是开源。
您可以使用禁用这些工具的使用应用程序帮助_禁用_外部_工具，但结果不会是有效的帮助手册，直到索引器在.lproj项目中的文件夹包裹。
-
applehelp_bundle_name（应用程序帮助绑定名称）
Apple帮助手册的基本名称。默认为项目名称。
-
应用程序帮助绑定id
帮助书捆绑包的捆绑包ID。
-
应用程序帮助_开发_区域
发展区域。默认为“en-us”，这是苹果的建议的设置。
-
应用程序帮助绑定版本
捆绑版本（作为字符串）。默认为'1'.
-
应用程序帮助图标
帮助捆绑图标文件，或无无图标。根据苹果公司文档，这应该是应用程序的16x16像素版本具有透明背景的图标，另存为PNG文件。
-
applehelp_kb_产品
用于的产品标签应用程序帮助_kb_url。默认为'<项目>-<发布>'.
-
应用程序帮助_kb_url
知识库服务器的URL，例如https://example.com/kbsearch.py？p='product'&q='query'&l='lang'.Help Viewer将替换这些值“产品”，'查询'和“lang”（语言）在运行时使用的内容applehelp_kb_产品，用户在搜索框和用户系统中输入的文本语言。
默认为无无需远程搜索。
-
应用程序帮助_remote_url
远程内容的URL。您可以放置帮助手册的副本资源文件夹，帮助查看器将尝试使用它可以获取更新的内容。
例如，如果您将其设置为https://example.com/help/Foo/和帮助查看器想要一份索引.html对于讲英语的客户，它将看，看https://example.com/help/Foo/en.lproj/index.html.
默认为无无远程内容。
-
应用程序帮助索引锚点
如果真的，告诉帮助索引器索引生成的HTML中的锚。这对于使用AHLookupAnchor（AH查找锚点）函数或openHelpAnchor:inBook:中的方法您的代码。它还允许您使用帮助：定位URL；看看苹果有关此主题的详细信息，请参阅文档。
-
应用程序最小长度
控制帮助索引器的最小字词长度。默认为无，这意味着将使用默认值。
-
应用帮助_停止字
语言规范（使用内置停止字），或stopwords plist的路径，或无如果你不想使用单字。默认的stopwords plist可以在以下位置找到/usr/share/hiutil/Stopwords.plist在撰写本文时，以下语言的关键词：
语言 |
代码 |
|---|
英语 |
英语 |
德国的 |
判定元件 |
西班牙的 |
锿 |
法语 |
前 |
瑞典语 |
sv公司 |
匈牙利语 |
胡 |
意大利人 |
它 |
默认为语言，或者如果未设置，则设置为“恩”.
-
应用程序帮助_区域设置
指定要为其生成帮助的区域设置。这用于确定的名称.lproj项目帮助书中的文件夹资源、和传递给帮助索引器。
默认为语言，或者如果未设置，则设置为“恩”.
-
应用程序帮助_标题
指定帮助手册标题。默认为'<项目> 帮助'.
-
应用程序帮助代码签名标识
指定用于代码签名的标识，或无if代码签名不执行。
默认为环境变量的值代码_符号_标识，由Xcode为脚本构建阶段设置，或者无如果该变量未设置。
-
应用程序帮助代码签名标志
一个列表要传递给的其他参数（共个）共同设计什么时候签署帮助手册。
默认为基于环境变量值的列表其他代码签名标签，由Xcode为脚本构建阶段设置，或空列表（如果未设置该变量）。
-
应用程序帮助索引器路径
通往希乌提程序。默认为“/usr/bin/hiutil”.
-
应用程序帮助代码设计路径
通往共同设计程序。默认为“/usr/bin/codesign”.
-
应用程序帮助_禁用_外部_工具
如果真的，生成器将不会运行索引器或代码签名工具，无论指定了什么其他设置。
这主要用于测试，或者您想在哪里运行Sphinx在非Mac OS X平台上构建，然后在OS X上完成最后的步骤出于某种原因。
默认为False（错误）.
epub输出选项
这些选项会影响epub输出。由于此生成器派生自HTML生成器，HTML选项也适用于适当的地方。的实际值有些选项并不重要，只需输入即可这个都柏林核心元数据.
-
epub_base名称
epub文件的基本名称。它默认为项目名称。
-
epub_主题
epub输出的HTML主题。因为默认主题不是针对小屏幕空间进行了优化，对HTML和epub使用相同的主题输出通常不明智。默认为“epub”，一个设计的主题以节省视觉空间。
-
epub主题选项
影响选定对象外观的选项字典主题。这些是特定于主题的。对于内置程序理解的选项主题，请参见这个部分.
-
epub_标题
文档的标题。它默认为html_标题选项但可以为epub创建单独设置。它默认为项目选项。
-
epub_说明
文档的描述。默认值为“未知”.
在版本1.5中进行了更改：重命名自epub3_描述
-
epub_作者
文件的作者。这放在都柏林核心元数据中。它默认为作者选项。
-
epub_贡献者
在EPUB出版物内容的创建。默认值为“未知”.
-
epub_语言
文档的语言。这放在都柏林核心元数据中。这个默认为语言选项或“恩”如果未设置。
-
epub_发布器
文档的发布者。这放在都柏林核心元数据中。您可以使用任何合理的字符串，例如项目主页。默认为这个作者选项。
-
epub_版权
文件的版权。它默认为版权选项，但可以为epub创建单独设置。
-
epub_标识符
文档的标识符。这被放在都柏林核心元数据中。对于已发布的文档，这是ISBN编号，但您也可以使用备选方案，例如项目主页。默认值为“未知”.
-
epub_方案
的发布方案epub_标识符.这个放进去了都柏林核心元数据。对于出版的书籍，该方案是“ISBN”.如果您可以使用项目主页，“URL”看起来很合理。默认值是“未知”.
-
epub_uid（&U）
文档的唯一标识符。这是放在都柏林核心区元数据。您可以使用XML的名称格式字符串。您不能使用连字符、句点和数字作为第一个字符。这个默认值为“未知”.
-
epub_覆盖
封面信息。这是一个包含以下文件名的元组封面图片和html模板。呈现的html封面是作为脊椎中的第一个项目插入内容.opf。如果模板文件名为空，没有创建html封面。根本没有掩护如果元组为空，则创建。示例：
epub_覆盖 = ('_static/cover.png'， “epub-cover.html”)
epub_覆盖 = ('_static/cover.png'， “”)
epub_覆盖 = ()
默认值为().
-
epub_css_文件
CSS文件列表。条目必须是文件名字符串或元组包含文件名字符串和属性字典。更多信息信息，请参见html_css_文件.
-
epub_指南
的guide元素的元数据内容.opf。这是一个包含类型，的uri（用户界面）和标题属于可选指南信息。请参阅OPF文档在https://idpf.org/epub了解详细信息。如果可能，默认条目对于盖和总有机碳类型将自动插入。然而，如果默认条目不是适当的。例子：
epub_指南 = ((“封面”， '封面.html'， '封面'),)
默认值为().
-
epub_pre_file文件
应在生成的文本之前插入的其他文件狮身人面像。它是包含文件名和标题的元组列表。如果标题为空，则不会向添加任何条目目录.cx。示例：
epub_pre_files（epub_pre文件） = [
('索引.html'， “欢迎”),
]
默认值为[].
-
epub_服务器文件
应在Sphinx生成的文本之后插入的其他文件。它是包含文件名和标题的元组列表。此选项可用于添加附录。如果标题为空，则不添加条目到目录.cx。默认值为[].
-
epub_exclude_files（排除文件）
在构建目录中生成/复制但应该不包括在epub文件中。默认值为[].
-
epub_toc深度
文件中目录的深度目录.cx.它应该是一个大于零的整数。默认值为3。注：A深嵌套的目录可能很难导航。
-
epub_tocdup
此标志确定是否在的开头再次插入toc条目它的嵌套toc列表。这样可以更轻松地导航到一章，但可能会混淆，因为它混合了不同的条目深度在一个列表中。默认值为真的.
-
epub_tocscope（epub_tocscope）
此设置控制epub目录的范围。设置可以具有以下值：
“默认”–包括所有未隐藏的toc条目（默认）
'包括隐藏'–包括所有toc条目
-
epub_fix图像
此标志确定sphinx是否应尝试修复非由一些epub读者支持。目前，调色板图像带有一个小颜色表已升级。你需要枕头，Python图像库，安装以使用此选项。默认值为False（错误）因为自动转换可能会丢失信息。
-
epub最大图像宽度
此选项指定图像的最大宽度。如果设置为值大于零，宽度大于给定值的图像为相应缩放。如果为零，则不执行缩放。默认值值为0。您需要安装Python图像库（枕头）才能使用此选项。
-
epub显示URL
控制是否显示URL地址。这对于没有其他方式显示链接URL的读取器设置可以具有以下值：
“内联”–在括号中显示内联URL（默认）
'脚注'–在脚注中显示URL
“否”–不显示URL
内联URL的显示可以通过为班链接目标.
-
epub使用索引
如果为true，请向epub文档添加索引。它默认为html使用索引选项，但可以为epub单独设置创造。
-
epub写入模式
它指定书写方向。它可以接受“水平”（默认）和“垂直”
epub写入模式
|
“水平”
|
“垂直”
|
|---|
写入模式 |
水平结核
|
垂直rl
|
|---|
页面前进 |
从左到右 |
从右到左 |
|---|
iBook的滚动主题支持 |
滚动轴是垂直的。 |
滚动轴是水平的。 |
|---|
LaTeX输出选项
这些选项会影响LaTeX输出。
-
latex发动机
用于构建文档的LaTeX引擎。设置可以有以下内容值：
“pdflatex”对Unicode字符的支持有限。
注释
2.0添加到“pdflatex”拉丁语文档支持偶尔出现西里尔或希腊字母或单词。这不是自动的，请参阅关于最新元素（_E） “字体”键。
如果项目使用Unicode字符，请将引擎设置为“xelatex”或“lualatex”并确保使用OpenType字体使用足够宽的字形覆盖通常比尝试制作更容易“pdflatex”使用额外的Unicode字符。自斯芬克斯2.0以来默认的是GNU FreeFont，它涵盖了拉丁语、西里尔语和希腊语。
在版本2.1.0中更改：使用X乳胶（和LaTeX包xeCJK公司)默认为中文文件。
在版本2.2.1中更改：使用乳胶默认情况下，对于希腊文档。
在版本4.0中更改：uplatex公司成为日语文档的默认设置。
与相反HTML输出中的MathJaX数学渲染，LaTeX需要一些额外的配置来支持中的Unicode文本数学：（据我们所知）唯一全面的解决方案是使用“xelatex”或“lualatex” 和添加r“\usepackage{unicode-math}”（例如，通过最新元素（_E）
'序言'键）。你可能更喜欢r'\usepackage[math-style=literal]{unicode-math}'保持Unicode文字，如α（U+03B1），例如输出中的原样，而不是呈现为\（\字母\）.
-
最新文档
此值确定如何将文档树分组到LaTeX源文件中。它必须是元组列表（startdocname， 目标名称， 标题， 作者，
主题， 仅限目录树），其中项目为：
- 启动文档名称
指定文件名称LaTeX文件主文件的文件。All documents referenced by thestartdoc公司TOC树中的文档将包含在LaTeX文件中。（如果要使用默认根目录LaTeX构建的文档，提供您的root_doc（根文件）此处。）
- 目标名称
输出目录中LaTeX文件的文件名。
- 标题
LaTeX文件标题。可以为空以使用startdoc公司文档。这是作为LaTeX标记插入的，因此像如果满足以下条件，反斜杠或与号必须由适当的LaTeX命令表示它们将按字面意思插入。
- 作者
LaTeX文档的作者。LaTeX标记警告与标题应用。使用\\和分隔多个作者，如：“约翰 \\和 莎拉'（反斜线必须经过Python扫描才能到达LaTeX）。
- 主题
LaTeX主题。请参见后期主题.
- 仅目录树（_O）
必须是真的或False（错误）。如果为真，则startdoc公司文档本身是不包括在输出中，只有它通过目录引用的文档树。使用此选项，您可以在主文档中添加额外内容显示在HTML中，但不显示在LaTeX输出中。
在版本1.2中添加：在过去，包括您自己的文档类需要您在带有字符串“sphinx”的文档类名。这是不必要的不再。
在版本0.3中添加：第6项仅目录树（_O）.仍接受带有5个项目的Tuples。
-
latex_logo
如果给定，这必须是图像文件的名称（相对于配置目录），这是文档的徽标。它被放置在标题页顶部。违约：无.
-
latex_toplevel_section
该值确定了最顶部的剖切单位。应该从中选择“部件”，'章节'或'节'。默认值为无;最上面的分段单元按documentclass进行切换：部分在以下情况下使用documentclass将是如何操作，否则章将使用。
注意，如果LaTeX使用\部分命令，然后对剖切进行编号单元一级深度与HTML编号不同步，因为LaTeX连续编号\章节（或\截面对于如何操作.)
-
最新附录
作为附录附加到所有手册中的文档名称列表。
-
最新域名
如果为true，则除了生成一般索引外，还要生成特定于域的索引。例如，对于Python域，这是全局模块索引。默认值为真的.
该值可以是一个布尔值或应生成的索引名列表，喜欢html域索引.
如果为true，请在内部引用之后添加页面引用。这很有用用于打印手册副本。默认值为False（错误）.
-
最新显示URL
控制是否显示URL地址。这对打印非常有用手册副本。该设置可以具有以下值：
“否”–不显示URL（默认）
'脚注'–在脚注中显示URL
“内联”–在括号中显示内联URL
在版本1.1中更改：这个值现在是一个字符串；以前它是一个布尔值，是一个true值选择了“内联”显示。为了向后兼容，真的仍被接受。
-
延迟使用日期多列
默认值为False（错误）：这意味着Sphinx自己的宏用于合并了网格表中的单元格。它们允许一般内容（文本块、，列表、方块引号…），但如果表格列该指令用于注入类型>{..}，<｛..｝，@{..}作为列规范。
设置为真的使用LaTeX标准的方式\多列; 这是与水平合并单元格中的文字块不兼容，并且如果使用列表式的.
-
latex表格样式
样式类（字符串）的列表。当前支持：
违约：[“书目”， '颜色行']
在6.0.0版本中更改：修改默认值[]到[“书目”， '颜色行'].
每个表都可以通过覆盖全局样式：类别：选项，或。。 第一类：对于无向表格（参见。桌子).当前认可的类是表格线条粗细的控制，无边界的，标准，颜色行，诺科罗斯后两者可以是与前三者中的任何一个结合在一起。这个标准类生成带有水平线和垂直线的表格（作为默认值斯芬克斯）。
如果是，单行多列合并单元格将遵循行颜色设置。另请参见TableMergeColor{页眉，奇数，偶数}在中sphinxsetup配置设置第节。
注释
LaTeX中的硬编码表示单个单元格将遵循行颜色即使通过设置了列颜色\柱状颜色来自柱规格（参见表格列). 斯芬克斯提供\狮身人面像norowcolor可以这样使用：
>{\柱状颜色{蓝色}\狮身人面像norowcolor}
在表列规范中。
狮身人面像还提供\狮身人面像彩色玻璃然而，这需要x色包装。下面是一个示例：
这意味着在此列中，行颜色将略微着色红色；参考x色有关its语法的更多信息的文档\混合颜色命令（a\混合颜色代替\狮身人面像彩色玻璃会改变电池的颜色目录，不是单元格的背景色面板…). 您可以找到以下示例中的用法不推荐的API本文档的第节PDF格式。
提示
如果您想为目录的给定列使用的单元格>{\noindent\color{<color>}}，可能还有上述情况。
多卷合并单元格，无论是单列还是多列当前忽略任何设置的列、行或单元格颜色。
简单的单元格可以通过未经加工的指令和\细胞颜色使用的LaTeX命令单元格内容中的任何位置。这目前无效在合并的单元格中，无论其类型如何。
提示
在不使用的文档中'书签'在全球范围内，可以设计通过表格线条粗细的控制上课，但这是必要的添加r“\usepackage{booktabs}”LaTeX前言。
另一方面，人们可以使用颜色行单个表的类没有额外的包装（因为斯芬克斯自5.3.0以来总是加载彩色tbl).
-
最晚使用日期
如果真的，由Sphinx创建的LaTeX文件生成的PDF版本将使用辛迪(文件)而不是标记索引用于编制通用术语索引（来自指数用法）。这意味着UTF-8字符的单词将获得为正确订购语言.
如果出现以下情况，则忽略此选项latex发动机是“平板”（日语文档；孟德斯替换标记索引然后）。
默认值为真的对于“xelatex”或“lualatex”作为标记索引，如果任何索引项以非ascii开头角色，创建.ind文件包含无效字节的文件UTF-8编码。使用“Lualate”这会破坏PDF生成。
默认值为False（错误）对于'pdflatex'但是真的是建议对非英语文档进行索引术语使用语言脚本中的非ascii字符。
斯芬克斯加入辛迪基础分发一些专用支持用于使用“pdflatex”使用西里尔文脚本的引擎。以及是否与“pdflatex”或Unicode引擎，西里尔文文档可以正确处理拉丁文名称索引，即使使用变音符号。
-
最新元素（_E）
-
它文档已移至LaTeX定制.
-
最新课程
字典映射“如何”和“手动”到真实文档的名称将用作两个Sphinx类的基础的类。违约是要使用'文章'对于“如何”和'报告'对于“手动”.
在版本1.5中更改：在日语文档中(语言是“ja”)，默认情况下“jreport”用于“如何操作”和“jsbook”对于'手动'.
-
延迟附加文件
相对于配置目录，要复制到的文件名列表生成LaTeX输出时的生成目录。这对复制很有用Sphinx不会自动复制的文件，例如，如果在添加了自定义LaTeX最新元素（_E）引用的.Image文件在源文件中（例如，通过。。 图像：：)自动复制。
你必须确保文件名不会与之冲突任何自动复制的文件。
敬告
带扩展名的文件名.tex码将自动移交给由触发的PDF生成过程狮身人面像建造 -M（M）
延迟xpdf或通过生成latexpdf。如果仅添加了文件成为\输入{}在修改的序言中，必须添加更多后缀，例如.txt文件并相应地调整\输入{}添加到LaTeX文档前言中的命令。
在版本1.2中更改：这将覆盖Sphinx提供的文件，例如狮身人面像.
-
后期主题
LaTeX输出应使用的“主题”。它是一组设置用于LaTeX输出（例如，文档类、顶层分段单元等）。
作为内置的LaTeX主题，手册和如何操作是捆绑的。
手册用于编写手册的LaTeX主题。它导入报告文件类（日语文档使用jsbook公司).
如何操作LaTeX撰写文章的主题。它导入文章文件类（日语文档使用j报告相反）。最新附录仅适用于此主题。
默认为“手动”.
-
最新主题选项
影响选定对象外观的选项字典主题。
-
延迟主题路径
包含自定义LaTeX主题作为子目录的路径列表。相对路径被视为相对于配置目录。
文本输出选项
这些选项会影响文本输出。
-
文本_换行
确定文本输出中使用的行尾字符。
违约：“unix”.
-
文本_节
一个由7个字符组成的字符串，用于给节添加下划线。第一个字符用于第一级标题，第二个字符用于二级标题等等。
默认值为'*=-~"+`'.
-
文本添加密码
决定文本输出中是否包含节号的布尔值。默认值为真的.
-
文本_序号_后缀
文本输出中节编号的后缀。违约：". "。设置为" "以抑制节号上的最后一个点。
手动页面输出选项
这些选项会影响手动页面输出。
-
手册页（_P）
此值确定如何将文档树分组为手动页面。它必须是元组列表（startdocname， 名称， 描述， 作者，
第节），其中项目为：
- 启动文档名称
指定文档名称手册页母版的文档。All documents referenced by thestartdoc公司TOC树中的文档将包含在手册文件中。（如果要使用默认值手动页面的根文档构建，使用root_doc（根文件）此处。）
- 名称
手册页面的名称。这应该是一个没有空格的短字符串或特殊字符。它用于确定文件名以及手册页面的名称（在name部分）。
- 描述
手册页面的描述。这在NAME部分中使用。如果不想自动生成，则可以是空字符串NAME部分。
- 作者
包含作者的字符串列表，或单个字符串。可以为空如果不想自动生成AUTHORS，请使用字符串或列表手册页中的第节。
- 部分
手册页面部分。用于输出文件名以及手动页眉。
-
手动显示URL
如果为true，请在链接后添加URL地址。默认值为False（错误）.
-
人工制造部分目录
如果为true，请在构建手册页上创建一个节目录。默认值为True。
在版本4.0中更改：默认值更改为False（错误）从真的.
在版本4.0.2中更改：默认值更改为真的从False（错误）再一次。
Texinfo输出选项
这些选项会影响Texinfo输出。
-
texinfo_文件
此值确定如何将文档树分组到Texinfo源中文件夹。它必须是元组列表（startdocname， 目标名称， 标题，
作者， 目录_条目， 描述， 类别， 仅限目录树），其中项目是：
- 启动文档名称
指定文档名称Texinfo文件的主文档。All documents referenced by thestartdoc公司中的文档目录树将包含在Texinfo文件中。（如果您想使用Texinfo构建的默认主文档，请提供root_doc（根文件）此处。）
- 目标名称
输出目录中Texinfo文件的文件名（无扩展名）。
- 标题
Texinfo文档标题。可以为空以使用startdoc公司文档。作为Texinfo标记插入，因此特殊字符如@和｛｝需要转义才能逐字插入。
- 作者
Texinfo文档的作者。作为Texinfo标记插入。使用@*分隔多个作者，如：“约翰@*Sarah”.
- 目录条目（_E）
将出现在顶层的名称总监菜单文件。
- 描述
顶层显示的描述性文本总监菜单文件。
- 类别
指定此条目将显示在顶层的节目录菜单文件。
- 仅目录树（_O）
必须是真的或False（错误）。如果为真，则startdoc公司文档本身是不包括在输出中，只有它通过目录引用的文档树。使用此选项，您可以在主文档中添加额外内容显示在HTML中，但不显示在Texinfo输出中。
-
texinfo_附件
作为附录附加到所有手册中的文档名称列表。
-
texinfo域索引
如果为true，则除了生成一般索引外，还要生成特定于域的索引。例如，对于Python域，这是全局模块索引。默认值为真的.
该值可以是一个布尔值或应生成的索引名列表，喜欢html域索引.
-
texinfo显示URL
控制如何显示URL地址。
'脚注'–在脚注中显示URL（默认）
“否”–不显示URL
“内联”–在括号中显示内联URL
如果为true，则不生成@详细信息菜单在“顶部”节点的菜单中包含文档中每个子节点的条目。默认值为False（错误）.
-
texinfo元素
包含覆盖这些Sphinx的Texinfo片段的字典通常放入生成的.特西文件夹。
-
texinfo_交叉引用
如果为false，则不要在文档中生成内联引用。这使得独立阅读器更易于阅读的信息文件(信息).默认值为真的.
QtHelp输出选项
这些选项会影响qthelp输出。由于此生成器源自HTML生成器，HTML选项也适用于适当的地方。
-
qthelp_base名称
qthelp文件的基本名称。它默认为项目名称。
-
qthelp_namespace
qthelp文件的命名空间。默认为org.sphinx公司<项目名称><项目版本>.
-
qthelp_主题
qthelp输出的HTML主题。默认为“nonav”.
-
qthelp_theme_options（qthelp主题选项）
影响选定对象外观的选项字典主题。这些是特定于主题的。对于内置程序理解的选项主题，请参见这个部分.
链接检查生成器的选项
-
链接检查忽略
与不应检查的URI匹配的正则表达式列表当执行链接检查生成。例子：
链接检查忽略 = [对'https://localhost:\d+/英寸]
-
链接检查允许重定向
将源URI的模式映射到规范模式的字典URI。在以下情况下，链接检查生成器会将重定向的链接视为“工作”：
文档中的链接与源URI模式匹配，并且
重定向位置与规范URI模式匹配。
例子：
链接检查允许的重定向 = {
#从源URI到规范URI的所有HTTP重定向都将被视为“有效”。
对'https://sphinx-doc网址\.org/.*”: 对'https://sphinx-doc网址\.org/en/master/.*'
}
如果设置，链接检查生成器将在不允许重定向时发出警告找到。在下检测意外重定向很有用这个
警告即错误 模式.
将baseurl映射到HTTP请求头的字典。
该键是一个URL基字符串，如下所示"https://www.sphinx-doc.org/"。要指定其他主机的标头，"*"可以使用。它仅在以下情况下匹配所有主机URL与其他设置不匹配。
该值是一个将标头名称映射到其值的字典。
例子：
链接检查请求标头 = {
"https://www.sphinx-doc.org/": {
“接受”: “文本/html”，
“接受编码”: “utf-8”，
},
“*”: {
“接受”: “text/html，application/xhtml+xml”，
}
}
-
链接检查重试
链接检查生成器在之前尝试检查URL的次数宣布它坏了。默认为1次尝试。
-
链接检查超时
链接检查生成器等待在每个超链接请求后进行响应。默认为30秒。
-
链接检查工作人员
检查链接时要使用的工作线程数。默认值为5线程。
-
链接check_anchors
如果为true，请检查#锚链接中的。因为这需要下载整个文档时，启用时速度会慢得多。默认值为真的.
-
链接check_anchors_ignore
当出现以下情况时，Sphinx应跳过匹配锚的正则表达式列表检查链接中锚的有效性。这允许跳过网站的JavaScript添加以控制动态页面，或在触发内部REST请求。默认值为["^!"].
注释
如果要忽略特定页面或与特定模式（但仍检查出现的相同页面没有锚），使用链接检查忽略相反，例如如下：
链接检查忽略 = [
'https://www.sphinx-doc.org/en/1.7/intro.html#'，
]
-
链接check_anchors_ignore_for_url
匹配URL的正则表达式的列表或元组斯芬克斯不应检查锚的有效性。这允许跳过每页的锚定检查同时仍然检查页面本身的有效性。默认值为空元组().
-
链接检查验证
执行时传递身份验证信息链接检查生成。
列表（正则表达式模式， 授权信息）包含以下项的元组：
- 正则表达式模式
与URI匹配的正则表达式。
- 身份验证信息
用于该URI的身份验证信息。该值可以是任何值可以被请求库（请参见请求身份验证详细信息）。
这个链接检查生成器将使用第一个匹配身份验证信息价值它可以在链接检查身份验证列表中的值列表具有更高的优先级。
例子：
链接检查身份验证 = [
('https://foo\.yourcompany\.com/.+”， (“约翰多”， “机密”)),
('https://.+\。您的公司\.com/.+， HTTPDigest授权(...)),
]
-
链接检查日期限制超时
这个链接检查构建器可能会向相同的网站在短时间内。此设置控制生成器行为当服务器指示请求是按速率限制的。
如果服务器指示何时重试（使用稍后重试标题），链接检查始终遵循服务器指示。
否则，链接检查等待一分钟后重试并保持两次尝试之间的等待时间加倍，直到成功或超过链接检查日期限制超时。默认情况下，超时为300秒自定义超时时间应以秒为单位。
-
链接检查排除文档
与Sphinx应该在其中使用的文档匹配的正则表达式列表不检查链接的有效性。这可用于允许链路衰减在文档的遗留或历史部分。
例子：
#忽略位于名为“legacy”的子文件夹中的文档中的所有链接
链接检查排除文档 = [对'.*/legage/.*']
-
链接检查允许授权
当Web服务器使用HTTP 401（未经授权）响应时Sphinx当前的默认行为是将链接视为“工作”。收件人更改该行为，将此选项设置为False（错误）.
此选项的默认值将在Sphinx 8.0中更改；从那开始版本以后，将处理对选中超链接的HTTP 401响应默认为“break”。
-
链接检查_报告_超时_中断
如果在配置的链接检查超时到期，Sphinx当前的默认行为是将链接视为“断开”。使用不同的报告代码报告超时超时，设置链接检查_报告_超时_中断到False（错误）.
从Sphinx 8.0起，检查超链接时发生的超时将使用新的“超时”状态代码进行报告。
XML生成器的选项
-
xml漂亮
如果为true，则漂亮地打印XML。默认值为真的.
脚注
C域的选项
-
c_id属性
解析器还应接受作为属性的字符串列表。例如，当属性#定义d用于便携性。
-
c_paren属性
解析器还应接受作为属性的字符串列表只有一个论点。那就是，如果我的对齐方式在列表中，那么my_align_as（X）被解析为所有字符串的属性X（X）有平衡支架(()，[]、和｛｝). 例如，可以使用当属性已经#定义d便于携带。
C解析器将识别为关键字的标识符列表。默认为['alignas'， '对齐'， “bool”， “复杂”， “想象”，
“noreturn”， “static_assert”， 'thread_local'].
-
c_maximum_signature_line_length（最大签名线长度）
如果签名的字符长度超过设置的数字参数将显示在单个逻辑行上。这是一个特定于域的设置，替代最大签名线长度.
C++域的选项
-
cpp_index公共前缀
对中的C++对象进行排序时将忽略的前缀列表全球指数。例如['awesome_lib:：'].
-
cpp_id_属性
解析器还应接受作为属性的字符串列表。例如，当属性#定义d用于可移植性。
-
cpp_paren属性
解析器还应接受作为属性的字符串列表只有一个论点。那就是，如果我的对齐方式在列表中，那么my_align_as（X）被解析为所有字符串的属性X（X）有平衡支架(()，[]、和｛｝). 例如，可以使用当属性已经#定义d便于携带。
-
cpp_最大签名线长度
如果签名的字符长度超过设置的数字参数将显示在单个逻辑行上。这是一个特定于域的设置，替代最大签名线长度.
Python域的选项
-
python显示短文类型
此值控制如何字面意义的将显示类型。默认情况下，该设置为布尔值False（错误）.
示例
下面的示例使用以下内容py：函数指令：
。。 py：函数::serve_food（项目：文字[“egg”，“spam”，“lobster therimdor”]）->无
什么时候？False（错误），字面意义的类型显示符合标准Python语法，即：
服务_食品(项目: 字面意义的[“鸡蛋”， “垃圾邮件”， “龙虾热敏电阻”]) -> 无
什么时候？真的，字面意义的类型显示为短，政治公众人物604-受启发的语法，即：
服务_食品(项目: “鸡蛋” | “垃圾邮件” | “龙虾热敏电阻”) -> 无
-
python使用未验证的类型名称
如果为true，则取消显示python引用的模块名（如果可以）断然的。默认值为False（错误）.
-
python最大签名行长度
如果签名的字符长度超过设置的数字，每个参数或类型参数将显示在单独的逻辑行上。这是特定于域的设置，重写最大签名线长度.
对于Python域，签名长度取决于正在格式化类型参数或参数列表。对于前者，签名长度忽略参数列表的长度；对于后者，签名长度忽略类型参数列表。
例如，使用蟒蛇最大签名长度 = 20，只包装类型参数列表而参数列表将在一行中呈现
。。 py：函数::添加[T:VERY_LONG_SUPER_TYPE，U:VERY/LONG_SUPER_TYPE]（a:T，b:U）
Javascript域的选项
-
javascript最大签名行长度
如果签名的字符长度超过设置的数字参数将显示在单个逻辑行上。这是一个特定于域的设置，替代最大签名线长度.
配置文件示例
#测试文档生成配置文件，由创建
#sphinx-quickstart，2016年6月26日00:00:43。
#
#此文件通过importlib.import_module执行
#当前目录设置为其包含的目录。
#
#注意，并非所有可能的配置值都出现在
#自动生成的文件。
#
#所有配置值都有默认值；注释掉的值
#用于显示默认值。
#如果扩展（或使用autodoc文档的模块）位于其他目录中，
#在此处将这些目录添加到sys.path。如果目录相对于
#文档根，使用os.path.abspath将其设置为绝对路径，如下所示。
#
#导入操作系统
#导入系统
#sys.path.insert（0，os.path.abspath（'.'））
#--一般配置------------------------------------------------
#如果您的文档需要最低版本的Sphinx，请在此处说明。
#
#needs_sphinx=“1.0”
#在此处添加任何Sphinx扩展模块名称，作为字符串。他们可以
#Sphinx附带的扩展（名为“Sphinx.ext.*”）或您的自定义
#个。
扩展 = []
#在此处添加相对于此目录包含模板的任何路径。
模板_路径 = ['模板（_T）']
#源文件名的后缀。
#您可以将多个后缀指定为字符串列表：
#
#source_suffix=[“.rst”，“.md”]
源后缀 = “.rst”
#源文件的编码。
#
#source_encoding='utf-8-sig'
#主目录树文档。
root_doc（根文件） = '索引'
#项目的一般信息。
项目 = “测试”
版权 = '2016，测试'
作者 = “测试”
#您正在记录的项目的版本信息将替代
#|version|和|release|，在整个
#构建文档。
#
#简短的X.Y版本。
版本 = “测试”
#完整版本，包括alpha/beta/rc标记。
释放 = “测试”
#Sphinx自动生成的内容语言。请参阅文档
#以获取支持的语言列表。
#
#如果您通过gettext目录进行内容翻译，也可以使用此功能。
#通常，您可以从命令行为这些情况设置“语言”。
语言 = 无
#替换“今天”有两个选项：或者，将“今天”设置为
#非假值，则使用：
#
#今天=“”
#
#否则，today_fmt用作strftime调用的格式。
#
#today_fmt=“%B%d，%Y”
#匹配文件和
#查找源文件时要忽略的目录。
#这些模式还影响html_static_path和html_extra_path
排除模式 = ['构建（_B）'， '拇指.db'， '.DS_存储']
#用于所有标记的reST默认角色（用于此标记：`text`）
#文档。
#
#default_role=无
#如果为true，则“（）”将附加到：func:etc.交叉引用文本。
#
#add_function_parentheses=真
#如果为true，则当前模块名称将添加到所有描述之前
#单元标题（例如..函数：：）。
#
#add_module_names=真
#如果为true，则sectionauthor和moduleauthor指令将显示在
#输出。默认情况下会忽略它们。
#
#show_authors=错误
#要使用的Pygments（语法突出显示）样式的名称。
pygments_style（复制样式） = “狮身人面像”
#模块索引排序的忽略前缀列表。
#modindex_common_prefix=[]
#如果为true，则在构建的文档中将警告作为“系统消息”段落保留。
#keep_warnings=假
#如果为true，则“todo”和“todoList”将生成输出，否则将不生成任何内容。
todo_include_todos = False（错误）
#--HTML输出选项----------------------------------------------
#用于HTML和HTML帮助页的主题。请参阅文档以了解
#内置主题列表。
#
html_主题 = “雪花石膏”
#主题选项是特定于主题的，可以自定义主题的外观
#进一步。有关每个主题的可用选项列表，请参阅
#文档。
#
#html_theme_options={}
#在此处相对于此目录添加包含自定义主题的任何路径。
#html_theme_path=[]
#这套狮身人面像文件的名称。
#默认情况下为“<project>v<release>documentation”。
#
#html_title='测试vtest'
#导航栏的较短标题。默认值与html_title相同。
#
#html_short_title=无
#要放置在顶部的图像文件的名称（相对于此目录）
#侧边栏的。
#
#html_logo=无
#要用作favicon的图像文件（相对于此目录）的名称
#文档。此文件应为16x16或32x32的Windows图标文件（.ico）
#像素大。
#
#html_favicon=无
#在此处添加任何包含自定义静态文件（例如样式表）的路径，
#相对于此目录。它们是在内置静态文件之后复制的，
#因此，名为“default.css”的文件将覆盖内置的“default.css”。
html静态路径 = ['静态（_S）']
#添加包含自定义文件的任何额外路径（例如robots.txt或
#.htaccess），相对于此目录。这些文件已复制
#直接指向文档的根。
#
#html_extra_path=[]
#如果不是None，则在每页插入“Last updated on：”时间戳
#底部，使用给定的strftime格式。
#空字符串等效于“%b%d，%Y”。
#
#html_last_updated_fmt=无
#自定义侧边栏模板，将文档名称映射到模板名称。
#
#html_sidebars={}
#应呈现到页面的其他模板将页面名称映射到
#模板名称。
#
#html_additional_pages={}
#如果为false，则不会生成模块索引。
#
#html_domain_indices=真
#如果为false，则不生成索引。
#
#html_use_index=真
#如果为true，则索引将被拆分为每个字母的单独页面。
#
#html_split_index=假
#如果为true，则指向reST源的链接将添加到页面中。
#
#html_show_sourcelink=真
#如果为true，HTML页脚中会显示“Created using Sphinx”（使用狮身人面像创建）。默认值为True。
#
#html_show_sphinx=真
#如果为true，HTML页脚中会显示“（C）版权…”。默认值为True。
#
#html_show_copyright=真
#如果为true，将输出OpenSearch描述文件，并且所有页面都将
#包含引用它的<link>标记。此选项的值必须是
#提供完成的HTML的基本URL。
#
#html_use_opensearch=“”
#这是HTML文件的文件名后缀（例如“.xhtml”）。
#html_file_suffix=无
#用于生成HTML全文搜索索引的语言。
#Sphinx支持以下语言：
#'da'，'de'，'en'，'es'，'fi'，'fr'，'hu'，'it'，'ja'
#'nl'，'no'，'pt'，'ro'，'ru'，'sv'，'tr'，'zh'
#
#html_search_language='en'
#带有搜索语言支持选项的字典，默认为空。
#“ja”使用此配置值。
#'zh'用户可以自定义更改'jieba'字典路径。
#
#html_search_options={“类型”：“默认”}
#javascript文件的名称（相对于配置目录）
#实现搜索结果记分器。如果为空，则使用默认值。
#
#html_search_scorer='scorer.js'
#HTML帮助生成器的输出文件基名称。
htmlhelp_base名称 = '测试文档'
#--LaTeX输出选项---------------------------------------------
最新元素（_E） = {
#纸张尺寸（“letterpaper”或“a4paper”）。
#
#'纸张尺寸'：'信纸'，
#字体大小（“10pt”、“11pt”或“12pt”）。
#
#“点大小”：“10pt”，
#LaTeX序言的附加内容。
#
#“序言”：“”，
#乳胶图（浮子）对齐
#
#'figure_align'：'htbp'，
}
#将文档树分组为LaTeX文件。元组列表
#（源起始文件、目标名称、标题、，
#author、documentclass（howto、manual或own类）。
最新文档 = [
(root_doc（根文件）， '测试.tex'， '测试文档'，
“测试”， “手动”),
]
#要放置在顶部的图像文件的名称（相对于此目录）
#标题页。
#
#latex_logo=无
#如果为true，则在内部链接后显示页面引用。
#
#latex_show_pagerefs=错误
#如果为true，则在外部链接后显示URL地址。
#
#latex_show_urls=错误
#作为所有手册附录的文件。
#
#latex_appendices=[]
#如果为false，则不会生成模块索引。
#
#latex_domain_indices=真
#--手动页面输出选项---------------------------------------
#每个手册页面一个条目。元组列表
#（源启动文件、名称、描述、作者、手册部分）。
手册页（_P） = [
(root_doc（根文件）， “测试”， '测试文档'，
[作者], 1)
]
#如果为true，则在外部链接后显示URL地址。
#
#man_show_urls=错误
#--Texinfo输出选项-------------------------------------------
#将文档树分组为Texinfo文件。元组列表
#（源开始文件、目标名称、标题、作者、，
#目录菜单项、描述、类别）
texinfo_文件 = [
(根目录， “测试”， '测试文档'，
作者， “测试”， '项目的单行描述。'，
“其他”),
]
#作为所有手册附录的文件。
#
#texinfo_appendices=[]
#如果为false，则不会生成模块索引。
#
#texinfo_domain_indices=真
#如何显示URL地址：“脚注”、“否”或“内联”。
#
#texinfo_show_urls='脚注'
#如果为true，则不要在“Top”节点的菜单中生成@detailmenu。
#
#texinfo_no_detailmenu=错误
#如果为false，则不要在手动@ref节点中生成。
#
#texinfo_cross_references=错误
#--随机示例-----------------------------------------------------
进口 系统， 操作系统
系统.路径.插入(0， 操作系统.路径.吸收路径('.'))
排除_模式 = [“zzz”]
numfig（数字） = 真的
#语言='ja'
扩展.追加('狮身人面像.ext.too')
扩展.追加(“sphinx.ext.autodoc”)
#扩展名.append（'phinx.ext.autosummary'）
扩展.追加('sphinx.ext.intersphinx')
扩展.追加('狮身人面像.ext.mathjax')
扩展.追加(“sphinx.ext.viewcode”)
扩展.追加('狮身人面像.外部.graphviz')
自动摘要生成 = 真的
html_主题 = “默认”
#source_suffix=[“.rst”，“.txt”]
