Move some testutils and overview docs to dev guide

[alexxy/gromacs.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index d78c59118ef62bf5bd238dd9627ecacb7aa9b6d4..6c4fdb86b3b9af40dd7c8a6f14cf82bc29bdfa1d 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -28,19 +28,50 @@ Contents:
 Documentation for developers
 ----------------------------
 
-Resources for developers, e.g., related to guidelines and tools used during
-development.
+The developer documentation currently consists of two parts:
+
+* A developer guide that provides an overview of the |Gromacs| codebase, and
+  includes more detailed resouces such as guidelines and information on tools
+  used during development.
+* Doxygen documentation extracted from comments in C/C++ code, documenting the
+  actual C/C++ code.
+
+Some overview documentation that is closely related to the actual C/C++ code
+appears in the Doxygen documentation, while some other overview content is in
+the developer guide.  The reasons are partially technical, but crosslinks
+between the developer guide and the Doxygen documentation are provided whenever
+related content appears split between the two sources.
+
+The documentation does not yet cover all areas, but more content is being
+(slowly) added.
+
+Contents:
 
 .. toctree::
    :maxdepth: 3
 
    dev-manual/index
 
-* `Doxygen public API documentation <doxygen/html-user/index.xhtml>`_
+* Doxygen documentation
+
+  * `Public API documentation <doxygen/html-user/index.xhtml>`_
+       This contains documentation for code that appears in installed headers,
+       as well as some overview documentation to understand those parts of the
+       code.
+       Please note that the definition of the public API is very preliminary
+       and subject to change, in particular for parts that have not been
+       documented.
+  * `Code documentation <doxygen/html-lib/index.xhtml>`_
+       This contains the public API documentation as a subset, but also has more
+       details on the internal implementation of |Gromacs|.  This is a good
+       place to start to understand some specific area of the code in general
+       to, e.g., contribute.
+  * `Full documentation <doxygen/html-full/index.xhtml>`_
+       This contains every single documented function from the codebase,
+       including internal  There can be an overwhelming amount of detail, but
+       this can be useful if trying to find some specific function within the
+       codebase.
 
-* `Doxygen code documentation <doxygen/html-lib/index.xhtml>`_
-     This contains the public API documentation as a subset, but also has more
-     details on the internal implementation of |Gromacs|.
 
 Indices and tables
 ==================