Browse Source

[autohelp] Add table label for RST reference

Each table need to be markuped up for reference.
In case the label is set at outside of inclusion,
Sphinx can not properly treat the label.

Change-Id: I2257471300ca5752ba717858a14d4fa26f62916f
changes/57/248357/2
KATO Tomoyuki 6 years ago
parent
commit
d881430418
  1. 1
      autogenerate_config_docs/autohelp.py
  2. 2
      autogenerate_config_docs/templates/autohelp.rst.j2

1
autogenerate_config_docs/autohelp.py

@ -403,6 +403,7 @@ def write_files(package_name, options, target, output_format):
items.append(item)
env['items'].append(items)
env['table_label'] = package_name + '-' + cat
ext = 'rst' if output_format == 'rst' else 'xml'
file_path = ("%(target)s/%(package_name)s-%(cat)s.%(ext)s" %

2
autogenerate_config_docs/templates/autohelp.rst.j2

@ -8,6 +8,8 @@
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _{{ table_label }}:
.. list-table:: Description of {{ nice_cat }} configuration options
:header-rows: 1
:class: config-ref-table

Loading…
Cancel
Save