antsibull-docs – 构建 Ansible 文档¶
此软件包提供用于验证和构建 Ansible 文档的工具。它主要由一个 CLI 工具 antsibull-docs 和一个 Sphinx 扩展组成。主要输出格式是 重结构化文本 (RST) 文件，供 Sphinx 使用。
集合维护者和作者应该查看此文档站点的 创建集合文档站点 部分。
antsibull-docs 受 Ansible 行为准则 的约束。
注意
需要帮助或想讨论项目？请参阅我们的 社区指南，了解如何加入讨论！
antsibull-docs 子命令¶
主要的 CLI 工具 antsibull-docs 具有多个子命令。
devel和stable子命令用于构建位于 docs.ansible.com/ansible/devel 和 docs.ansible.com/ansible/latest 的官方 Ansible 文档站点。current和collection子命令用于为单个集合构建文档站点。plugin和collection-plugins子命令用于呈现单个（或所有）插件、模块或角色的文档。lint-collection-docs和lint-core-docs子命令用于检查集合和 ansible-core 文档的代码风格。前者在 创建集合文档站点 中有更详细的说明。sphinx-init子命令用于设置基于 Sphinx 的集合文档站点。这在 创建集合文档站点 中有更详细的说明。
使用 Sphinx 扩展¶
sphinx_antsibull_ext Sphinx 扩展 提供最小的 CSS 和书面 RST 文件使用的几个角色，以正确呈现文档。要使用它，请将其包含在 Sphinx 配置 conf.py 中。
# Add it to 'extensions':
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'notfound.extension', 'sphinx_antsibull_ext']
可以使用 antsibull_ext_color_scheme 配置来配置扩展使用的配色方案。目前，支持以下值：
default：默认颜色。default-dark：深色配色方案。default-autodark：根据prefers-color-scheme媒体查询，使用默认颜色或深色颜色。none：不定义颜色。如果您想用自己的定义覆盖所有颜色，并且不需要包含默认颜色，可以使用此选项。
默认配色方案可以在 src/sphinx_antsibull_ext/css/colors-default.scss 中找到。有关颜色定义的工作方式，请参阅 MDN 关于使用 CSS 自定义属性的页面。
请注意，配色方案仅适用于 HTML 输出。LaTeX/PDF 输出的颜色是硬编码的，目前无法修改。
许可证¶
除非代码中另有说明，否则它是在 GNU 通用公共许可证 v3 或您选择的更高版本条款下授权的。请参阅 LICENSES/GPL-3.0-or-later.txt 获取许可证副本。
该存储库遵循 REUSE 规范 来声明版权和许可信息。唯一的例外是 changelog/fragments/ 中的变更日志片段。