Using documentation tools

The OpenStack documentation toolkit includes a number of scripts used for performing automated tasks to maintain the OpenStack documentation project. For example, there are tools that generate a sitemap, check niceness, synchronize files used across multiple repositories, and others.

This section provides an overview of the documentation tools and their location, explains how to install, configure, use, and contribute to them.

• Scripts overview
  • openstackdocstheme
  • oslo.config
  • oslo.policy
  • cliff
  • stevedore
  • openstack-doc-tools repository
  • openstack-manuals repository
  • Notes
• Template generator details
  • The template files
  • Defining release series
  • Project data file format
  • Template variables
  • Common tasks
• Install OpenStack documentation tools
• Contribute to OpenStack documentation tools
  • Contribute to the tool development
  • File a bug against the tools