脚本总览¶
本节概述了 OpenStack 文档项目使用的脚本，面向作者和开发者，按它们所属的组件进行分组。
openstackdocstheme¶
openstackdocstheme 是 Sphinx 文档的主题和扩展支持，发布到 docs.openstack.org。它提供了一个外部链接助手，可以自动构建在为每个发布系列创建分支时发生变化的链接。
有关更多信息，请参阅 外部链接助手。
oslo.config¶
oslo.config 库提供了两个扩展，一个配置文档指令和一个配置生成器钩子。
有关更多信息，请参阅 oslo.config 的 Sphinx 集成 和 Sphinx Oslo 示例配置生成。
oslo.policy¶
oslo.policy 库提供了两个扩展，一个策略文档指令和一个策略生成器钩子。
有关更多信息，请参阅 Sphinx Oslo 示例策略生成。
cliff¶
cliff 框架提供了一个指令来记录多个命令。
有关更多信息，请参阅 cliff 的 Sphinx 集成。
stevedore¶
stevedore 库提供了一个指令，用于列出入口点的插件。
有关更多信息，请参阅 stevedore 的 Sphinx 集成。
openstack-doc-tools 仓库¶
- sitemap
生成
sitemap.xml文件。- bin
包含用于在
openstack-manuals仓库中构建文档的脚本。在 tox 环境中使用。
openstack-manuals 仓库¶
目前有几个脚本驻留在 openstack-manuals 仓库中。将这些脚本整合到 openstack-doc-tools 仓库中可能是有益的。
- www-generator.py
生成基于模板的静态 HTML 文件，用于 https://docs.openstack.org/。有关更多信息，请参阅 模板生成器详情。
- sync-projects.sh
同步 术语表、通用文件和一些翻译，跨多个仓库，包括
api-site和security-doc。- publishdocs.sh
Publishdocs 作业使用此脚本将文档发布到 https://docs.openstack.org/。
说明¶
openstack-doc-tools必须发布，以便可以在 requirements 文件中固定它，从而实现跨仓库的自动化。各种文档仓库之间存在许多未记录的同步（自动化和手动）。这些应该被记录下来。
有一些作业必须定期运行，例如更新
sitemap.xml文件和命令行配置参考。这些应该被记录下来。一些手动作业应该被自动化。例如，
sitemap.xml文件应该由 Gerritbot 自动更新。
