Link man pages in documentation
authorMichael Hanselmann <hansmi@google.com>
Tue, 8 Jan 2013 15:21:29 +0000 (16:21 +0100)
committerMichael Hanselmann <hansmi@google.com>
Tue, 15 Jan 2013 14:43:37 +0000 (15:43 +0100)
commit5ce58234aafc1a68861f168b06d65bad22f48f82
treed47376527d428cb2cf6dcc85596b6daf746ffd14
parenta7f0953a4f4855f04797804cf3083c4b56d838c3
Link man pages in documentation

This patch depends on “Option to include man pages in documentation”. In
the documentation build including man pages, all “:manpage:`…`”
references are converted to links. For man pages not provided by Ganeti,
Sphinx' standard formatting is used.

A small dance is necessary to hook into Sphinx' processing of man page
roles and to generate automatically resolved links. The code converts
“:manpage:`…`” for known man pages to the data structure equivalent of
“:doc:`$name($section) <man-$name>`”. Additionally it checks the section
numbers and formatting of references (in all builds).

Signed-off-by: Michael Hanselmann <hansmi@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>
Makefile.am
lib/build/sphinx_ext.py