openstack/openstack-doc-tools

History

Gauvain Pocentek ecc3744a72 Fix extract_swift_flags.py The renaming of the swift-conf-changes.xml in the openstack-manual repository broke a test in the extract_swift_flags.py script. This patch changes the test to make the script work again. Change-Id: I71b6960801163c2d2c52253d0c9a45ec2bf02b0d		2014-10-07 07:07:06 +02:00
..
test	Bump hacking to 0.9.x series	2014-06-12 09:17:22 +02:00
__init__.py	Rename autogenerate-config-docs to autogenerate_config_docs	2014-01-21 17:00:22 +01:00
autohelp-wrapper	wrapper: clean the source dir before a checkout	2014-09-08 06:36:47 +02:00
autohelp.py	autohelp: Remove trailing spaces from help strings	2014-10-03 08:40:03 +02:00
diff_branches.py	diff_branches: improve the generated title	2014-09-09 21:31:50 +02:00
extract_swift_flags.py	Fix extract_swift_flags.py	2014-10-07 07:07:06 +02:00
flow.dia	Rename autogenerate-config-docs to autogenerate_config_docs	2014-01-21 17:00:22 +01:00
hooks.py	Don't fail if glance_store is not available	2014-09-28 20:49:03 +02:00
README.rst	Update the autohelp readme	2014-08-26 08:25:07 +02:00
requirements.txt	Update the autohelp readme	2014-08-26 08:25:07 +02:00

README.rst

autogenerate_config_docs

Automatically generate configuration tables to document OpenStack.

Using the wrapper

autohelp-wrapper is the recommended tool to generate the configuration tables. Don't bother using autohelp.py manually.

The autohelp-wrapper script installs a virtual environment and all the needed dependencies, clones or updates the projects and manuals repositories, then runs the autohelp.py script in the virtual environment.

New and updated flagmappings are generated in the openstack-manuals repository (tools/autogenerate-config-flagmappings/ directory).

The workflow is:

$ pip install -rrequirements.txt
$ ./autohelp-wrapper update
$ $EDITOR sources/openstack-manuals/tools/autogenerate-config-flagmappings/*.flagmappings
$ ./autohelp-wrapper docbook
$ # check the results in sources/openstack-manuals

This will generate the tables for all the known projects.

To generate the mappings and tables for a subset of projects, use the code names as arguments:

$ ./autohelp-wrapper update cinder heat
$ # edit the mappings files
$ ./autohelp-wrapper docbook cinder heat

Creating mappings for a new project

Run the wrapper with the create subcommand:

$ ./autohelp-wrapper create zaqar

Flagmappings files

The flagmappings files use the following format:

OPTION_SECTION/OPTION_NAME group1 [group2, ...]

Groups need to be defined manually to organize the configuration tables.

The group values can only contain alphanumeric characters, _ and - (they will be used as docbook IDs).

To make the table titles more user friendly, create or edit the PROJECT.headers file in the manuals repository. Each line of this file is of the form:

GROUP A Nice Title

Working with branches

autohelp-wrapper works on the master branch by default, but you can tell it to work on another branch:

$ ./autohelp-wrapper update -b stable/icehouse

Note

The -b switch doesn't apply to the openstack-manuals repository which will be left untouched (no git branch, no git update).

Updating swift options

Swift configuration tables are generated using the extract_swift_flags.py script. This script doesn't use a mapping file, but organize the tables using the various configuration files and sections. Most of the options must be described manually at the moment.