docs/index.rst

   1 =======================================
   2 Welcome to the |Gromacs| documentation!
   3 =======================================
   4
   5 ..  TODO : consolidate at least some of the material in the
   6     Documentation links below into the new user guide, along with all
   7     of http://www.gromacs.org/Documentation/Cut-off_schemes,
   8     http://www.gromacs.org/Documentation/Acceleration_and_parallelization
   9     and http://www.gromacs.org/Documentation/Performance_checklist)
  10
  11 .. only:: html
  12
  13         The complete documentation is also available as a `printable PDF here`_. The documentation
  14         for other versions of |GROMACS| can be found at http://manual.gromacs.org/documentation
  15
  16         .. toctree::
  17            :maxdepth: 1
  18
  19            download
  20            release-notes/index
  21            install-guide/index
  22            user-guide/index
  23            how-to/index
  24            reference-manual/index
  25            gmxapi/index
  26            dev-manual/index
  27
  28         ==================
  29         Indices and tables
  30         ==================
  31
  32         * :ref:`genindex`
  33
  34 .. only:: latex
  35
  36       The release notes can be found online at http://manual.gromacs.org/current/release-notes/index.html
  37
  38          .. toctree::
  39             :maxdepth: 1
  40
  41             download
  42             install-guide/index
  43             user-guide/index
  44             how-to/index
  45             reference-manual/index
  46             gmxapi/index
  47             dev-manual/index
  48
  49
  50 .. _printable PDF here: `gmx-manual`_
  51
  52