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