openstack
/
openstack-doc-tools
Code Issues Proposed changes

README: Remove references to flagmappings 

Change-Id: I2bf35a11e3386093e56662d1ae1382f09796ccfe
This commit is contained in:
Stephen Finucane 2017-03-07 17:31:54 +00:00
parent 9b3b5f5775
commit 1630dbf436
1 changed files with 6 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
autogenerate_config_docs/README.rst
View File

@ -15,9 +15,6 @@ 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.
@ -52,47 +49,25 @@ The workflow is:
.. code-block:: console
$ 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, then the driver/plugin has to be explicitly installed within the
virtual environment to generate the configuration options.
.. note::
When building the neutron documentation, if the driver/plugin resides
outside the neutron repository, 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:
.. code-block:: console
$ ./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 document 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
---------------------