Use `todo` Sphinx directive more.
[alexxy/gromacs.git] / docs / user-guide / index.rst
1 .. _user guide:
2
3 **********
4 User guide
5 **********
6
7 .. highlight:: bash
8
9 This guide provides
10
11 * material introducing |Gromacs|
12 * practical advice for making effective use of |Gromacs|.
13
14 For getting, building and installing |Gromacs|, see the
15 :doc:`/install-guide/index`.
16 For background on algorithms and implementations, see the
17 :ref:`reference manual part <gmx-reference-manual-rst>` of the documentation.
18
19 |GMX_MANUAL_DOI_STRING|
20
21 |GMX_SOURCE_DOI_STRING|
22
23 .. todo::
24
25    This is going to require more organization now that
26    we are getting more content available.
27
28 .. toctree::
29    :maxdepth: 2
30
31    getting-started
32    system-preparation
33    managing-simulations
34    faq
35    force-fields
36    cmdline
37    mdp-options
38    mdrun-features
39    mdrun-performance
40    run-time-errors
41    cmdline
42    terminology
43    environment-variables
44    floating-point
45    security
46    deprecation-policy