abbd98e952
Move the docs for the template generator input files to the contributor guide. Expand the docs to explain the template variables and the data set within the generator code. Change-Id: I9f98c78bc4b13ea64b6cb96537e81b69267905b1 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
25 lines
806 B
ReStructuredText
25 lines
806 B
ReStructuredText
.. _doc-tools:
|
|
|
|
=========================
|
|
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 configuration and
|
|
command-line interface references, 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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
doc-tools/scripts.rst
|
|
doc-tools/template-generator.rst
|
|
doc-tools/installation.rst
|
|
doc-tools/cli-reference.rst
|
|
doc-tools/config-reference.rst
|
|
doc-tools/contributing.rst
|