Update README for autogenerate_config_docs
Change-Id: I0e4d8043b6471949300a9d327a8f301a4ed6e5d3
This commit is contained in:
parent
43ee2e967a
commit
885bbcdf6b
|
@ -32,7 +32,7 @@ The workflow is:
|
||||||
$ pip install -rrequirements.txt
|
$ pip install -rrequirements.txt
|
||||||
$ ./autohelp-wrapper update
|
$ ./autohelp-wrapper update
|
||||||
$ $EDITOR sources/openstack-manuals/tools/autogenerate-config-flagmappings/*.flagmappings
|
$ $EDITOR sources/openstack-manuals/tools/autogenerate-config-flagmappings/*.flagmappings
|
||||||
$ ./autohelp-wrapper docbook
|
$ ./autohelp-wrapper rst
|
||||||
$ # check the results in sources/openstack-manuals
|
$ # check the results in sources/openstack-manuals
|
||||||
|
|
||||||
This will generate the tables for all the known projects.
|
This will generate the tables for all the known projects.
|
||||||
|
@ -48,7 +48,7 @@ names as arguments:
|
||||||
|
|
||||||
$ ./autohelp-wrapper update cinder heat
|
$ ./autohelp-wrapper update cinder heat
|
||||||
$ # edit the mappings files
|
$ # edit the mappings files
|
||||||
$ ./autohelp-wrapper docbook cinder heat
|
$ ./autohelp-wrapper rst cinder heat
|
||||||
|
|
||||||
|
|
||||||
Creating mappings for a new project
|
Creating mappings for a new project
|
||||||
|
@ -90,7 +90,7 @@ to work on another branch:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
$ ./autohelp-wrapper update -b stable/icehouse
|
$ ./autohelp-wrapper update -b stable/liberty
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The ``-b`` switch doesn't apply to the ``openstack-manuals`` repository
|
The ``-b`` switch doesn't apply to the ``openstack-manuals`` repository
|
||||||
|
|
Loading…
Reference in New Issue