Replace tool HTML help with Sphinx-generated docs
authorTeemu Murtola <teemu.murtola@gmail.com>
Sun, 1 Feb 2015 05:25:41 +0000 (07:25 +0200)
committerRoland Schulz <roland@rschulz.eu>
Fri, 13 Feb 2015 09:33:46 +0000 (10:33 +0100)
commit389918c50f268127b3d0497b27715987dc2caea4
tree98c3e6c87ccb093e241249e589742d9f4601bfd2
parent4850184f0fb64e7196c2cb5ae2ee87c038a0f4c9
Replace tool HTML help with Sphinx-generated docs

Instead of generating HTML pages directly, make 'gmx help -export rst'
export reStructuredText that is used as input for Sphinx to generate the
help pages as part of the Sphinx documentation.  Make other docs refer
to these with a native Sphinx construct :ref:`gmx something`, as it
seems not possible to make `gmx something`_ really work.
:doc:`/programs/gmx-something` works even nicer, but is a bit too much
typing.

Make various minor corrections to existing help documentation so that
they can be converted to rst without errors; the output is still very
ugly in several places (but it wasn't any better in the old HTML...).
This change does not aim to fix all problems; it will probably be easier
once we have more freedom in using different rst constructs.
Links to file formats do not work, but those should be easier to fix
once the file format descriptions are also in rst.

Remove installation of the old share/html/ pages, as there is very
little stuff left there.

Change-Id: Ie9d7f1435656d9cf1f60a7e1c4c3c2e440af227d
20 files changed:
docs/CMakeLists.txt
docs/conf.py
docs/install-guide/index.rst
docs/old-html/CMakeLists.txt
docs/user-guide/getting-started.rst
docs/user-guide/tools.rst
src/gromacs/commandline/cmdlinehelpmodule.cpp
src/gromacs/commandline/cmdlinehelpwriter.cpp
src/gromacs/gmxana/gmx_chi.c
src/gromacs/gmxana/gmx_current.c
src/gromacs/gmxana/gmx_hbond.c
src/gromacs/gmxana/gmx_rmsdist.c
src/gromacs/gmxana/gmx_trjcat.c
src/gromacs/gmxana/gmx_tune_pme.c
src/gromacs/gmxana/gmx_wham.cpp
src/gromacs/gmxpreprocess/grompp.c
src/gromacs/onlinehelp/helpwritercontext.cpp
src/gromacs/onlinehelp/helpwritercontext.h
src/gromacs/trajectoryanalysis/modules/freevolume.cpp
src/programs/mdrun/mdrun.cpp