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 may
  11 require the documentation to be updated in sync.  Wiki pages at
  12 http://www.gromacs.org/Developer_Zone contain additional information (much of
  13 it outdated, though), and can be linked from relevant locations in this guide.
  14
  15 The guide is currently split into a few main parts:
  16
  17 * Overview of the |Gromacs| codebase.
  18 * Generic guidelines to follow when developing |Gromacs|.
  19   For some of the guidelines, scripts exist (see below) to automatically
  20   reformat the code and/or enforce the guidelines for each commit.
  21 * Instructions on what tools are used, and how to use them.
  22
  23 .. toctree::
  24    :maxdepth: 2
  25
  26    overview
  27    style
  28    tools