Option to include man pages in documentation
Before this patch, HTML versions of man pages (man/*.rst) were already built. However, since they are separate from the normal documentation, their content is not indexed for Sphinx' search functionality. Additionally it would simply be nice to have everything in one place. To this end a new configure-time option is added to enable the inclusion of man pages into the documentation. A dedicated option is necessary to still be able to provide a static documentation build in the tarball (not including man pages) as man pages contain build-specific paths and values. The documentation with man pages is written to the directory “doc/man-html”. A future patch will extend Sphinx to link occurences of “:manpage:`…`” to these man pages. Signed-off-by:Michael Hanselmann <hansmi@google.com> Reviewed-by:
Guido Trotter <ultrotter@google.com>
Showing
- .gitignore 3 additions, 0 deletions.gitignore
- Makefile.am 68 additions, 7 deletionsMakefile.am
- NEWS 4 additions, 0 deletionsNEWS
- autotools/run-in-tempdir 3 additions, 3 deletionsautotools/run-in-tempdir
- autotools/sphinx-wrapper 38 additions, 0 deletionsautotools/sphinx-wrapper
- configure.ac 20 additions, 0 deletionsconfigure.ac
- doc/conf.py 10 additions, 1 deletiondoc/conf.py
- doc/index.rst 1 addition, 0 deletionsdoc/index.rst
- doc/manpages-disabled.rst 11 additions, 0 deletionsdoc/manpages-disabled.rst
Loading
Please register or sign in to comment