[openstack-dev] [opinion-wanted] Clients man pages

Jakub Ruzicka jruzicka at redhat.com
Thu May 23 19:00:19 UTC 2013


On 23.5.2013 17:02, Pete Zaitcev wrote:
> On Wed, 22 May 2013 07:46:45 -0400
> Sean Dague <sean at dague.net> wrote:
> 
>> My experience is that you never get a good result trying to create man 
>> pages out of comments embedded in the code.
> 
> Ditto
> 
>> I'd suggest doing rst in doc/source like is being done with other 
>> projects. The sphinx rules can build man format easily enough.
> 
> Is there an example you can recommend?

Not sure about the recommendability, but nova (as well as glance,
quantum and likely others) has this in doc/source/man

man pages need to be listed in doc/source/conf.py


Jakub



More information about the OpenStack-dev mailing list