format command line app documentation using sphinx features

Bug #947261 reported by Doug Hellmann
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)

Bug Description

Sphinx provides directives and roles for describing command line programs. We should use them for nova-manage.

Changed in nova:
assignee: nobody → Doug Hellmann (doug-hellmann)
Tom Fifield (fifieldt)
Changed in nova:
status: New → Incomplete
status: Incomplete → Confirmed
Thierry Carrez (ttx)
Changed in nova:
importance: Undecided → Wishlist
Revision history for this message
Romain Chantereau (romain-m) wrote :

This syntax does not permit option without “-”, “--“ or “/” prefix when using sphinx 1.1.3.

This issue is not present in sphinx 1.2.2.

Revision history for this message
Romain Chantereau (romain-m) wrote :

But generate a WARNING at reference call

for instance:

.. program:: nova-manage

.. option:: db version

    Print the current database version.

:option:`nova-manage db version`

WARNING: Malformed :option: u'nova-manage db version', does not contain option marker - or -- or /

Changed in nova:
assignee: Doug Hellmann (doug-hellmann) → nobody
Revision history for this message
Markus Zoeller (markus_z) (mzoeller) wrote :

This wishlist bug has been open a year without any activity. I'm going
to move it to "Opinion / Wishlist", which is an easily-obtainable queue
of older requests that have come on. If you want to work on this,
just push a patch to Gerrit, there's no need to track this with a
bug report.

If there are any questions left, feel free to contact me (markus_z)
in the IRC channel #openstack-nova

Changed in nova:
status: Confirmed → Opinion
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Related blueprints

Remote bug watches

Bug watches keep track of this bug in other bug trackers.