Generate man pages through Sphinx
authorTeemu Murtola <teemu.murtola@gmail.com>
Sun, 1 Feb 2015 20:29:40 +0000 (22:29 +0200)
committerRoland Schulz <roland@rschulz.eu>
Fri, 13 Feb 2015 09:34:47 +0000 (10:34 +0100)
commit93c5a430030a6277cd3383420d77568220fd90ce
tree438d8397dc47795ca260625851e49845182c0de9
parent389918c50f268127b3d0497b27715987dc2caea4
Generate man pages through Sphinx

Instead of writing direct nroff markup from 'gmx help -export man',
generate the man pages using Sphinx from the same source that is used
for the HTML help.  This makes the code a lot more maintainable, and
enables using the same markup everywhere; where necessary for more
flexible formatting, the code can now be simply changed to emit direct
reStructuredText, and that get reasonably formatted in both contexts.
This should allow actually improving the man page contents in the
future.

For man pages, GMX_BUILD_HELP now only controls whether the installation
tries to install man pages or not; they are never built automatically,
as it now takes a substantial amount of time and requires Sphinx that
most people will not have available.

Currently the layout of the man pages (in particular gromacs.7) is not
very nice, but the situation is comparable to what it was earlier.

Change-Id: I3b581933369e573af5cbd614950c2a667a1c6fa4
12 files changed:
CMakeLists.txt
CPackInit.cmake
docs/CMakeLists.txt
docs/conf.py
docs/man/BuildManPages.cmake [deleted file]
docs/man/CMakeLists.txt [deleted file]
docs/man/gromacs.7.rst [new file with mode: 0644]
docs/man/man7/gromacs.7.in [deleted file]
src/gromacs/commandline/cmdlinehelpmodule.cpp
src/gromacs/commandline/cmdlinehelpwriter.cpp
src/gromacs/onlinehelp/helpwritercontext.cpp
src/gromacs/onlinehelp/helpwritercontext.h