History

Gauvain Pocentek 87f23f539f Make diff_branches.py work again Changes to autohelp.py have broken the diff_branches.py script. This patch fixes the script: - add a ``dump`` subcommand and a ``-q`` (quiet) option to autohelp-wrapprt - use these options in diff_branches.py - remove the dependency on python-git as it is not needed anymore. Change-Id: I5d5a7e7141e1a0df1c86d52daae35fe5f33f239b		2016-03-20 18:44:17 +01:00
..
releasenotes/notes	Move the config items in the manuals repository	2016-01-11 08:52:33 +01:00
templates	[diff_branches] Handle empty values in RST tables	2015-12-10 09:50:35 +01:00
README.rst	Fix a typo in autogenerate_config_docs/README.rst	2016-03-19 10:06:58 +09:00
__init__.py	Rename autogenerate-config-docs to autogenerate_config_docs	2014-01-21 17:00:22 +01:00
autohelp-wrapper	Make diff_branches.py work again	2016-03-20 18:44:17 +01:00
autohelp.py	Better identify deprecated configuration options	2016-03-16 18:08:07 -04:00
diff_branches.py	Make diff_branches.py work again	2016-03-20 18:44:17 +01:00
extract_swift_flags.py	[autohelp] config-ref-rst moves to config-reference	2015-12-20 20:56:08 +01:00
requirements.txt	Make diff_branches.py work again	2016-03-20 18:44:17 +01: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).

Prior to running the following commands you need to install several development packages. For Ubuntu install the required packages with the following command:

$ sudo apt-get install python-dev libxml2-dev libxslt1-dev zlib1g-dev \
                       libmysqlclient-dev libpq-dev libffi-dev \
                       libsqlite3-dev libldap2-dev libsasl2-dev \
                       libjpeg-dev liberasurecode-dev

The workflow is:

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

This will generate the tables for all the known projects. Note for Neutron project: If the driver/plugin resides outside the Neutron repository in stackforge, then the driver/plugin has to be explicitly installed within the virtual environment to generate the configuration options.

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 rst cinder heat

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 -b stable/liberty update

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.