openstack
/
openstack-doc-tools
Code Issues Proposed changes

Allow bulleted lists in config reference 

This is very much a hack, but its really just to see if it is possible
to convert the bullet lists into text that renders correctly with rst.

This was tested with the nova-hyperv.rst:
f0607509e3/doc/config-reference/source/tables/nova-hyperv.rst

Change-Id: Iab063774f6732d52cd8e79f82ff0fc93bd6d306b
This commit is contained in:
John Garbutt 2016-05-26 14:33:57 +01:00 committed by John Garbutt
parent 329e410bfd
commit 4f0433ffce
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
autogenerate_config_docs/autohelp.py
View File

@ -459,8 +459,15 @@ def write_files(package_name, options, target, output_format):
if not option.help:
option.help = "No help text available for this option."
helptext = option.help.strip().replace('\n', ' ')
helptext = option.help.strip()
helptext = helptext.replace('\n\n', '$sentinal$')
helptext = helptext.replace('\n*', '$sentinal$*')
helptext = helptext.replace('\n', ' ')
helptext = ' '.join(helptext.split())
# TODO(johngarbutt) space matches only the current template :(
helptext = helptext.replace('$sentinal$', '\n\n ')
if option.deprecated_for_removal:
if not option.help.strip().startswith('DEPRECATED'):
helptext = 'DEPRECATED: ' + helptext