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 * `Reference Manual`_ (PDF format)
  21
  22 .. * Answers to `Frequently Asked Questions <http://www.gromacs.org/Documentation/FAQs>`_
  23
  24 .. * Coping with `errors while using |Gromacs| <http://www.gromacs.org/Documentation/Errors>`_
  25
  26 * Links to `tutorial material <http://www.gromacs.org/Documentation/Tutorials>`_
  27
  28 Documentation for developers
  29 ----------------------------
  30
  31 The developer documentation currently consists of two parts:
  32
  33 * A developer guide that provides an overview of the |Gromacs| codebase, and
  34   includes more detailed resouces such as guidelines and information on tools
  35   used during development.
  36 * Doxygen documentation extracted from comments in C/C++ code, documenting the
  37   actual C/C++ code.
  38
  39 Some overview documentation that is closely related to the actual C/C++ code
  40 appears in the Doxygen documentation, while some other overview content is in
  41 the developer guide.  The reasons are partially technical, but crosslinks
  42 between the developer guide and the Doxygen documentation are provided whenever
  43 related content appears split between the two sources.
  44
  45 The documentation does not yet cover all areas, but more content is being
  46 (slowly) added.
  47 Wiki pages at <http://www.gromacs.org/Developer_Zone> may contain additional
  48 information (much of it outdated, though), and can be linked from relevant
  49 locations in the developer guide.
  50
  51 Contents:
  52
  53 .. toctree::
  54    :maxdepth: 3
  55
  56    dev-manual/index
  57
  58 * Doxygen documentation
  59
  60   * `Public API documentation <doxygen/html-user/index.xhtml>`_
  61        This contains documentation for code that appears in installed headers,
  62        as well as some overview documentation to understand those parts of the
  63        code.
  64        Please note that the definition of the public API is very preliminary
  65        and subject to change, in particular for parts that have not been
  66        documented.
  67   * `Code documentation <doxygen/html-lib/index.xhtml>`_
  68        This contains the public API documentation as a subset, but also has more
  69        details on the internal implementation of |Gromacs|.  This is a good
  70        place to start to understand some specific area of the code in general
  71        to, e.g., contribute.
  72   * `Full documentation <doxygen/html-full/index.xhtml>`_
  73        This contains every single documented function from the codebase,
  74        including internal  There can be an overwhelming amount of detail, but
  75        this can be useful if trying to find some specific function within the
  76        codebase.
  77
  78
  79 Indices and tables
  80 ==================
  81
  82 * :ref:`genindex`
  83
  84 .. _Reference Manual: `gmx-manual`_