docs/reference-manual/index.rst

   1 .. _gmx-reference-manual-rst:
   2
   3 ****************
   4 Reference Manual
   5 ****************
   6
   7 .. highlight:: bash
   8
   9 .. todo:: this needs to be carefully checked that I didn't mess anything up too bad
  10
  11 .. ifconfig:: gmx_image_convert == 'possible'
  12
  13    This part of the documentation covers implementation details of |Gromacs|.
  14
  15    For quick simulation set-up and short explanations,
  16    please refer to the :ref:`User guide <user guide>`.
  17
  18    Help with the installation of |Gromacs| can be found in the
  19    :ref:`Install guide <install guide>`.
  20
  21    If you want to help with developing |Gromacs|, your are most welcome
  22    to read up on the :ref:`Developer Guide <dev guide>` and continue
  23    right away with coding for |Gromacs|.
  24
  25    .. toctree::
  26       :maxdepth: 2
  27
  28       preface
  29       introduction
  30       definitions
  31       algorithms
  32       functions
  33       topologies
  34       file-formats
  35       special
  36       run-parameters
  37       analysis
  38       details
  39       averages
  40       references
  41
  42
  43 .. ifconfig:: gmx_image_convert == 'impossible'
  44
  45    The manual could not be properly build because we could not
  46    convert the images for proper display without Imagemagick.
  47    The rest of the documentation is still there, but this part here will be missing.
  48
  49    For quick simulation set-up and short explanations,
  50    please refer to the :ref:`User guide <user guide>`.
  51
  52    Help with the installation of |Gromacs| can be found in the
  53    :ref:`Install guide <install guide>`.
  54
  55    If you want to help with developing |Gromacs|, your are most welcome
  56    to read up on the :ref:`Developer Guide <dev guide>` and continue
  57    right away with coding for |Gromacs|.
  58
  59    .. toctree::
  60       :maxdepth: 2
  61
  62       preface
  63       introduction
  64       definitions
  65       topologies
  66       file-formats
  67       run-parameters
  68       details
  69       averages
  70       references
  71