openstack
/
openstack-doc-tools
Code Issues Proposed changes

Remove :option: 

Sphinx 1.5 warns about :option: usage without .. option:: description.
Since we do not use .. option:: to describe parameter, remove
:option: from the tools.

Change-Id: I995ad6772b8cc65b8ff255a1c2dad96bdff8adbc
This commit is contained in:
Andreas Jaeger 2017-01-11 15:03:27 +01:00 committed by KATO Tomoyuki
parent c29d578224
commit fe3c0e0d86
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
os_doc_tools/commands.py
View File

@ -40,11 +40,6 @@ def quote_rst(line):
line = line.replace('\\', '\\\\').replace('`', '\\`').replace('*', '\\*')
if '--' in line:
line = re.sub(r'(--[^ .\'\\]*)', r":option:`\1`", line)
# work around for "`--`" at murano
line = line.replace('\\`:option:`--`\\`', '```--```')
if 'DEPRECATED!' in line:
line = line.replace('DEPRECATED!', '**DEPRECATED!**')
elif 'DEPRECATED' in line:
@ -691,7 +686,7 @@ def document_single_project(os_command, output_dir, continue_on_error):
format_heading("Image service API v1 commands", 2, out_file)
out_file.write("As of this version, the default API version is 2.\n")
out_file.write("You can select an API version to use by adding the\n")
out_file.write(":option:`--os-image-api-version` parameter or by\n")
out_file.write("``--os-image-api-version`` parameter or by\n")
out_file.write("setting the corresponding environment variable:\n\n")
out_file.write(".. code-block:: console\n\n")