docs/index.rst

   1 Welcome to the |Gromacs| documentation!
   2 =======================================
   3
   4 ..  TODO : consolidate at least some of the material in the
   5     Documentation links below into the new user guide, along with all
   6     of http://www.gromacs.org/Documentation/Cut-off_schemes,
   7     http://www.gromacs.org/Documentation/Acceleration_and_parallelization
   8     and http://www.gromacs.org/Documentation/Performance_checklist)
   9
  10 Contents:
  11
  12 .. toctree::
  13    :maxdepth: 2
  14
  15    download
  16    install-guide/index
  17
  18    user-guide/index
  19
  20    online
  21
  22 * `Reference Manual`_ (PDF format)
  23
  24 * Answers to `Frequently Asked Questions <http://www.gromacs.org/Documentation/FAQs>`_
  25
  26 * Coping with `errors while using GROMACS <http://www.gromacs.org/Documentation/Errors>`_
  27
  28 * Links to `tutorial material <http://www.gromacs.org/Documentation/Tutorials>`_
  29
  30 Documentation for developers
  31 ----------------------------
  32
  33 * `Doxygen public API documentation <doxygen/html-user/index.xhtml>`_
  34
  35 * `Doxygen code documentation <doxygen/html-lib/index.xhtml>`_
  36      This contains the public API documentation as a subset, but also has more
  37      details on the internal implementation of |Gromacs|.
  38
  39 * `Developer Guide <doxygen/html-lib/page_devmanual.xhtml>`_
  40      Resources for developers, e.g., related to guidelines and tools used during
  41      development.
  42
  43 Indices and tables
  44 ==================
  45
  46 .. TODO this does nothing so far, but it will later
  47
  48 * :ref:`genindex`
  49
  50 .. _Reference Manual: `gmx-manual`_