[OpenStack-docs] Process to add a table in openstack-manuals
Gauvain Pocentek
gauvain.pocentek at objectif-libre.com
Wed Aug 31 08:58:06 UTC 2016
Hello Vinita,
Le 2016-08-31 10:12, Deshpande, Vinita a écrit :
> Hello everybody,
>
> I have raised a pull request in openstack for our CoprHD volume
> driver documentation in openstack-manuals project. Pull request :
> https://review.openstack.org/#/c/352822/ [1]
>
> My driver doc uses a table (cinder-coprhd.rst), which is supposed to
> be auto-generated as per a comment given on the pull request. As I am
> completely new to this, can someone please guide me on how to add the
> table in "doc/config-reference/source/tables" ?
>
> I have already added ".. include:: ../../tables/cinder-coprhd.rst" in
> my documentation.
The tools that can generate this file is in the openstack-doc-tools git
repo:
https://github.com/openstack/openstack-doc-tools/tree/master/autogenerate_config_docs
The README describes how you can setup your environment, then you would
have to run:
$ ./autohelp-wrapper update cinder
$ vim
sources/openstack-manuals/tools/autogenerate-config-flagmappings/cinder.*
$ ./autohelp-wrapper rst cinder
In the cinder.flagmappings file you have to add a 'coprhd' next to the
options you driver brings, and you can add a 'coprhd' entry in the
cinder.headers file to get a nice title for the table.
HTH,
Gauvain
More information about the OpenStack-docs
mailing list