openstack
/
openstack-doc-tools
Code Issues Proposed changes

Improve output of CLI documentation 

* highlight client version (<literal>VERSION</literal>)
* use "ceilometer meter-list" instead of "ceilometer meter-list command"
  as title for subcommands

Change-Id: I4ef841df4122af25eab7c7efae97a1ef87d39057
This commit is contained in:
Christian Berendt 2014-09-09 21:33:02 +02:00
parent 38dc33b799
commit cdde3005f5
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
os_doc_tools/commands.py
View File

@ -95,7 +95,7 @@ def generate_heading(os_command, api_name, title, os_file):
header3 = """
This chapter documents <command>%(os_command)s</command> version
%(version)s.
<literal>%(version)s</literal>.
</para>
<para>For help on a specific <command>%(os_command)s</command>
@ -364,7 +364,7 @@ def generate_subcommand(os_command, os_subcommand, os_file):
os_subcommandid = os_subcommand.replace(' ', '_')
os_file.write(" <section xml:id=\"%sclient_subcommand_%s\">\n"
% (os_command, os_subcommandid))
os_file.write(" <title>%s %s command</title>\n"
os_file.write(" <title>%s %s</title>\n"
% (os_command, os_subcommand))
if os_command == "swift":