Blueprint-evolution-of-autogenerate-config-docs

• Launchpad Entry: Evolve autogenerate tools
• Created: Andreas Jaeger
• Contributors:
• Planned implementation release: Icehouse

Overview

The current autogenerate tools have a couple of limitations and we need to improve the tool to handle all current uses in the manuals. We should also evaluate switching to generator.py from oslo-incubator - and enhancing that tool.

Blueprint

Current limitations and problems

• The filenames, and sections within them are not shown at all
• We need to be able to show the same option in different tables for shared options
• Options with the same name - but specified in different tables - will show up as duplicated entries in a table.

New format for generated tables

The tables should additionally contain the section, for example [DEFAULT]

Related bug reports

• Duplicates in generated tables