docs/dev-manual/index.rst

   1 ***************
   2 Developer guide
   3 ***************
   4
   5 This set of pages contains guidelines, instructions, and explanations related
   6 to |Gromacs| development.  The actual code is documented in Doxygen
   7 documentation linked from the front page of the documentation.
   8
   9 The focus is (at least for now) on things that are tightly tied to the code
  10 itself, such as helper scripts that reside in the source repository and
  11 organization of the code itself, and may require the documentation to be
  12 updated in sync.
  13
  14 The guide is currently split into a few main parts:
  15
  16 * Overview of the |Gromacs| codebase.
  17 * Collection of overview pages that describe some important implementation
  18   aspects.
  19 * Generic guidelines to follow when developing |Gromacs|.
  20   For some of the guidelines, scripts exist (see below) to automatically
  21   reformat the code and/or enforce the guidelines for each commit.
  22 * Instructions on what tools are used, and how to use them.
  23
  24 .. toctree::
  25    :maxdepth: 2
  26
  27    overview
  28    relocatable-binaries
  29    style
  30    tools