diff options
| author | Antoine Musso <hashar@free.fr> | 2014-05-15 12:23:29 +0200 |
|---|---|---|
| committer | Antoine Musso <hashar@free.fr> | 2014-05-16 21:36:08 +0200 |
| commit | fb5018382f0fcf04f78ffa8d6bc19afd585ebdbc (patch) | |
| tree | 686a2ff30992fde5963d8a19125deaca05b16be1 | |
| parent | 5bdcfef2af1c0c685252730b0f57f615787c985d (diff) | |
| download | gear-fb5018382f0fcf04f78ffa8d6bc19afd585ebdbc.tar.gz | |
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
| -rw-r--r-- | doc/source/conf.py | 6 | ||||
| -rw-r--r-- | doc/source/geard.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 2 |
3 files changed, 6 insertions, 3 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 7816277..5dc2e4e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. diff --git a/doc/source/geard.rst b/doc/source/geard.rst new file mode 100644 index 0000000..aa0f922 --- /dev/null +++ b/doc/source/geard.rst @@ -0,0 +1 @@ +.. program-output:: geard --help diff --git a/doc/source/index.rst b/doc/source/index.rst index 8fb361a..6ab1677 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 --------------- |