Beanbag文档格式的Sphinx实用程序模块。
beanbag-docutils的Python项目详细描述
=========
beanbag doc utilities
======
这是一个实用程序集合，有助于生成
beanbag相关产品的文档，包括：
*`review board`-我们广泛使用的开源代码评审产品。
*rbcommons`-我们的评审委员会SaaS。
*djblets`-一套基于django的项目的实用工具和基础设施。
*rbtools`-评审委员会和rbcommons的命令行工具。
_评审委员会：https://www.review board.org/
…_ rbcommons:https://www.rbcommons.com/
。_ djblets:https://github.com/djblets/djblets/
。_ rbtools:https://github.com/reviewboard/rbtools/
_ sphinx:http://www.sphinx-doc.org/
>增强了对beanbag docstring格式的autodoc支持，并允许
从文档中排除内容。
但是添加了一些内容：
*一个新的``context:``部分来描述在
上下文管理器（包括变量）的上下文中发生的事情。
*新的``model attributes:``和`` option args:``部分用于定义模型上的
属性或使用javascript时的字典。
*新的``已弃用：```，``版本已添加：``，和``版本已更改：``节
用于定义与版本相关的信息。
*分析改进允许跨行包装参数类型，
这在具有长模块时非常有用路径不适合一行。
这需要加载"sphinx.ext.napoleon"模块。
它们的格式与`````````所有```相同，因为它们接受顶级类、函数和变量的字符串列表
。这里列出的任何内容都将从任何autodoc代码中排除。
``````````autodoc``排除``在记录从子模块导入内容并将其重新导出到`````all``中的
````时特别方便。在这种情况下，autodoc通常会输出
in````uu init_uuu.py``和子模块中的文档，但可以通过设置来避免这一点：
excludes也可以全局定义，并根据
docstring所属的对象类型进行筛选。有关
的详细信息，请参阅autodoc-skip-member的文档。您可以在"conf.py"中配置它，方法是：
autodoc excludes={
适用于模块、类和任何其他内容。
'*'：[
''uu dict'，
''uu doc'，
''uu module'，
''uu weakref'，
]，
'类'：[
对django模型有用。
'不反对'，
'多对象返回'，
'对象'，
有用的表单。
'基本字段'，
'媒体'，
]，
}
只是一个例子，但对django用户来说很有用。
要安装此扩展，请在"conf.py"中添加以下内容：
_ autodoc-skip-member:
http://www.sphinx-doc.org/en/stable/ext/autodoc.html；事件autodoc skip member
收集生成目录中的其他文件。
这用于将源目录中的文件（由glob模式指示）复制到目标生成目录中。每个目标文件将
位于树中相同的相对位置。
可能包含要随文档一起提供的元数据或打包。
若要使用此功能，只需在以下文件中添加扩展名：file:`conf.py`：
extensions=[
…
'beanbag_docutils.sphinx.ext.collect_files'，
…
]
然后将"collect_file_patterns"配置为
文件名/全局模式的列表，例如：
collect_file_patterns=['metadata.json'，"*.pdf"]
django实用程序在autodocs中使用基于django的类时添加一些改进，在引用django文档时添加一些改进。
这对表单和模型很有用。
其次，这添加了基于设置的文档链接，允许记录和引用自定义的设置（来自``django.conf.settings```），
就像这样：
代码块：：rst
…设置：：my_setting
settings进入此处。
…
]
github链接代码
----
将模块、类等的源代码链接到github上的正确行。
这避免了将源代码与文档捆绑在一起，
并更好地将所有内容联系在一起。
要使用此功能，只需在"conf.py"中添加以下内容：
from beanbag_docutils.sphinx.ext.github import github_linkcode_resolve
extensions=[
…
"sphinx.ext.linkcode"，
…
]
linkcode_resolve=github_linkcode_resolve
>提供http代码的引用，链接到维基百科上的匹配文档。
要创建链接，简单地说：：
这是：http:`404`.
如果您想使用不同的url，可以将以下内容添加到
``conf.py``:：
，其中'`%s``将被http代码替换。
要安装此扩展，在"conf.py"中添加以下内容：
extensions=[
…
"beanbag_docutils.sphinx.ext.http_role"，
…
]
intersphinx实用程序
----
通过修复"option"引用的问题和通过添加新的指令来设置要使用的intersphinx文档集的优先级顺序来增强intersphinx。
使用：
…默认intersphinx：：myapp1.5 python
：ref:`some reference`
这将确保使用不带显式前缀
的intersphinx的引用将首先尝试"myapp1.5"，然后是"python"。不会使用其他intersphinx集
。
若要安装此扩展，请在"conf.py"中添加以下内容：
extensions=[
…
"sphinx.ext.intersphinx"，
"beanbag_docutils.sphinx.ext.intersphinx"，
…
]
请注意，这些扩展必须按此顺序列出。
ref-utils
--
允许python和javascript跨多行引用中断路径（如``foo.bar.myClass``）。
要安装此扩展，请在``conf.py```中添加以下内容：/>
扩展名=[
…
beanbag_docutils.sphinx.ext.ref_utils'，
…
]
retina_images
----
这与retina.js.
等脚本很好地配合，要安装此扩展，请在"conf.py"中添加以下内容：
extensions=[
…
"beanbag_docutils.sphinx.ext.retina_images"，
…
]
。_ retina.js:https://imulus.github.io/retinajs/
beanbag doc utilities
======
这是一个实用程序集合，有助于生成
beanbag相关产品的文档，包括：
*`review board`-我们广泛使用的开源代码评审产品。
*rbcommons`-我们的评审委员会SaaS。
*djblets`-一套基于django的项目的实用工具和基础设施。
*rbtools`-评审委员会和rbcommons的命令行工具。
_评审委员会：https://www.review board.org/
…_ rbcommons:https://www.rbcommons.com/
。_ djblets:https://github.com/djblets/djblets/
。_ rbtools:https://github.com/reviewboard/rbtools/
_ sphinx:http://www.sphinx-doc.org/
>增强了对beanbag docstring格式的autodoc支持，并允许
从文档中排除内容。
但是添加了一些内容：
*一个新的``context:``部分来描述在
上下文管理器（包括变量）的上下文中发生的事情。
*新的``model attributes:``和`` option args:``部分用于定义模型上的
属性或使用javascript时的字典。
*新的``已弃用：```，``版本已添加：``，和``版本已更改：``节
用于定义与版本相关的信息。
*分析改进允许跨行包装参数类型，
这在具有长模块时非常有用路径不适合一行。
这需要加载"sphinx.ext.napoleon"模块。
它们的格式与`````````所有```相同，因为它们接受顶级类、函数和变量的字符串列表
。这里列出的任何内容都将从任何autodoc代码中排除。
``````````autodoc``排除``在记录从子模块导入内容并将其重新导出到`````all``中的
````时特别方便。在这种情况下，autodoc通常会输出
in````uu init_uuu.py``和子模块中的文档，但可以通过设置来避免这一点：
excludes也可以全局定义，并根据
docstring所属的对象类型进行筛选。有关
的详细信息，请参阅autodoc-skip-member的文档。您可以在"conf.py"中配置它，方法是：
autodoc excludes={
适用于模块、类和任何其他内容。
'*'：[
''uu dict'，
''uu doc'，
''uu module'，
''uu weakref'，
]，
'类'：[
对django模型有用。
'不反对'，
'多对象返回'，
'对象'，
有用的表单。
'基本字段'，
'媒体'，
]，
}
只是一个例子，但对django用户来说很有用。
要安装此扩展，请在"conf.py"中添加以下内容：
_ autodoc-skip-member:
http://www.sphinx-doc.org/en/stable/ext/autodoc.html；事件autodoc skip member
收集生成目录中的其他文件。
这用于将源目录中的文件（由glob模式指示）复制到目标生成目录中。每个目标文件将
位于树中相同的相对位置。
可能包含要随文档一起提供的元数据或打包。
若要使用此功能，只需在以下文件中添加扩展名：file:`conf.py`：
extensions=[
…
'beanbag_docutils.sphinx.ext.collect_files'，
…
]
然后将"collect_file_patterns"配置为
文件名/全局模式的列表，例如：
collect_file_patterns=['metadata.json'，"*.pdf"]
django实用程序在autodocs中使用基于django的类时添加一些改进，在引用django文档时添加一些改进。
这对表单和模型很有用。
其次，这添加了基于设置的文档链接，允许记录和引用自定义的设置（来自``django.conf.settings```），
就像这样：
代码块：：rst
…设置：：my_setting
settings进入此处。
…
]
github链接代码
----
将模块、类等的源代码链接到github上的正确行。
这避免了将源代码与文档捆绑在一起，
并更好地将所有内容联系在一起。
要使用此功能，只需在"conf.py"中添加以下内容：
from beanbag_docutils.sphinx.ext.github import github_linkcode_resolve
extensions=[
…
"sphinx.ext.linkcode"，
…
]
linkcode_resolve=github_linkcode_resolve
>提供http代码的引用，链接到维基百科上的匹配文档。
要创建链接，简单地说：：
这是：http:`404`.
如果您想使用不同的url，可以将以下内容添加到
``conf.py``:：
，其中'`%s``将被http代码替换。
要安装此扩展，在"conf.py"中添加以下内容：
extensions=[
…
"beanbag_docutils.sphinx.ext.http_role"，
…
]
intersphinx实用程序
----
通过修复"option"引用的问题和通过添加新的指令来设置要使用的intersphinx文档集的优先级顺序来增强intersphinx。
使用：
…默认intersphinx：：myapp1.5 python
：ref:`some reference`
这将确保使用不带显式前缀
的intersphinx的引用将首先尝试"myapp1.5"，然后是"python"。不会使用其他intersphinx集
。
若要安装此扩展，请在"conf.py"中添加以下内容：
extensions=[
…
"sphinx.ext.intersphinx"，
"beanbag_docutils.sphinx.ext.intersphinx"，
…
]
请注意，这些扩展必须按此顺序列出。
ref-utils
--
允许python和javascript跨多行引用中断路径（如``foo.bar.myClass``）。
要安装此扩展，请在``conf.py```中添加以下内容：/>
扩展名=[
…
beanbag_docutils.sphinx.ext.ref_utils'，
…
]
retina_images
----
这与retina.js.
等脚本很好地配合，要安装此扩展，请在"conf.py"中添加以下内容：
extensions=[
…
"beanbag_docutils.sphinx.ext.retina_images"，
…
]
。_ retina.js:https://imulus.github.io/retinajs/
欢迎加入QQ群-->： 979659372
