openstack-doc-tools/autogenerate_config_docs/templates/autohelp.docbook.j2

59 lines
1.8 KiB
Django/Jinja

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_{{ pkg }}_{{ cat }}">
<caption>Description of {{ nice_cat }} configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{% for group in groups %}
<tr>
<th colspan="2">[{{ group }}]</th>
</tr>
{% for item in items[loop.index0] %}
<tr>
<td><option>{{ item[0] }}</option> = <replaceable>{{ item[1] }}</replaceable></td>
<td>
<p>{{ item[2] | replace('<', '&lt;') | replace('>', '&gt;') }}</p>
{% if len(item) >= 4 %}
<dl>
{% for flagname, flagdesc in item[3] %}
<dt>{{ flagname }}</dt><dd>{{ flagdesc }}</dd>
{% endfor %}
</dl>
{% endif %}
</td>
</tr>
{% endfor %}
{% endfor %}
</tbody>
</table>
</para>