opendev
/
gear
Code Issues Proposed changes

Generate a geard.8 manpage for Debian packaging 

I have created a Debian package for gear and the Debian policy requires
daemon to ship with a manpage.

This patch:
* extracts out geard program output out of index.rst to a new geard.rst
  including it at the original place for convenience.
* configure sphinx to generate a geard.8 manpage from geard.rst
* geard.rst remains unlinked in the HTML documentation since it is
  included in index.rst.

Minor issue:
* I haven't found how to add cross references between the two manpages
  without interfering with the HTML documentation output.

Change-Id: I2576cfa4acb0b91d789dc1ce42299ae91c6f9422
This commit is contained in:
Antoine Musso 2014-05-15 12:23:29 +02:00
parent 5bdcfef2af
commit fb5018382f
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -214,8 +214,10 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'gear', u'Gear Documentation',
[u'OpenStack Foundation'], 1)
('index', 'gear', u'Gear Full Documentation',
[u'OpenStack Foundation'], 1),
('geard', 'geard', u'async pure python Gearman daemon',
[u'OpenStack Foundation'], 8),
]
# If true, show URL addresses after external links.

1
doc/source/geard.rst Normal file
View File

@ -0,0 +1 @@
.. program-output:: geard --help

2
doc/source/index.rst
View File

@ -63,7 +63,7 @@ Server Example
You can run the Gearman server by executing the `geard` command. For help
execute `geard --help`
.. program-output:: geard --help
.. include:: geard.rst
SSL Connections
---------------