openstack
/
openstack-doc-tools
Code Issues Proposed changes

extract_swift_flags: add RST support 

Change-Id: Icf4e03f344bbccccac80f6d84da59d3b62210900
This commit is contained in:
Gauvain Pocentek 2015-11-10 20:19:39 +01:00
parent eb5f13ba99
commit 8bbf73babe
2 changed files with 32 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
autogenerate_config_docs/extract_swift_flags.py
View File

@ -140,7 +140,7 @@ def extract_descriptions_from_devref(swift_repo, options):
return option_descs
def write_docbook(options, manuals_repo):
def write_files(options, manuals_repo, output_format):
"""Create new DocBook tables.
Writes a set of DocBook-formatted tables, one per section in swift
@ -160,15 +160,21 @@ def write_docbook(options, manuals_repo):
for full_section, options in all_options.items():
sample_filename, section = full_section.split('|')
tmpl_file = os.path.join(os.path.dirname(__file__),
'templates/swift.docbook.j2')
'templates/swift.%s.j2' % output_format)
with open(tmpl_file) as fd:
template = jinja2.Template(fd.read(), trim_blocks=True)
output = template.render(filename=sample_filename,
section=section,
options=options)
tgt_filename = (manuals_repo + '/doc/common/tables/' +
'swift-' + sample_filename + '-' + section + '.xml')
with open(tgt_filename, 'w') as fd:
if output_format == 'docbook':
tgt = (manuals_repo + '/doc/common/tables/' + 'swift-' +
sample_filename + '-' + section + '.xml')
else:
tgt = (manuals_repo + '/doc/config-ref-rst/source/tables/' +
'swift-' + sample_filename + '-' + section + '.rst')
with open(tgt, 'w') as fd:
fd.write(output)
@ -248,10 +254,11 @@ def main():
parser = argparse.ArgumentParser(
description="Update the swift options tables.",
usage="%(prog)s docbook|dump [-v] [-s swift_repo] [-m manuals_repo]")
usage=("%(prog)s docbook|rst|dump [-v] [-s swift_repo] "
"[-m manuals_repo]"))
parser.add_argument('subcommand',
help='Action (docbook, dump).',
choices=['docbook', 'dump'])
help='Action (docbook, rst, dump).',
choices=['docbook', 'dump', 'rst'])
parser.add_argument('-s', '--swift-repo',
dest='swift_repo',
help="Location of the swift git repository.",
@ -276,8 +283,8 @@ def main():
read_options(args.swift_repo, args.manuals_repo, args.verbose)
options = OptionsCache()
if args.subcommand == 'docbook':
write_docbook(options, args.manuals_repo)
if args.subcommand in ('docbook', 'rst'):
write_files(options, args.manuals_repo, args.subcommand)
elif args.subcommand == 'dump':
options.dump()

15
autogenerate_config_docs/templates/swift.rst.j2 Normal file
View File

@ -0,0 +1,15 @@
..
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
.. list-table:: Description of configuration options for ``[{{ section }}]`` in ``{{ filename }}.conf``
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
{% for option in options %}
* - ``{{ option[0] }}`` = ``{{ option[1]|default(' ', true) }}``
- {{ option[2] }}
{% endfor %}