docs/gmxsphinx.py

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2015, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 from sphinx import addnodes
  36
  37 class MdpNodeParser(object):
  38     def __init__(self):
  39         self._current_option = None
  40
  41     def parse_option(self, env, text, nodes):
  42         nodes += addnodes.desc_name(text, text)
  43         self._current_option = text
  44         return text
  45
  46     def parse_value(self, env, text, nodes):
  47         nodes += addnodes.desc_name(text, text)
  48         if self._current_option is None:
  49             return text
  50         return self._current_option + '=' + text
  51
  52 def setup(app):
  53     mdp_parser = MdpNodeParser()
  54     app.add_object_type('mdp', 'mdp',
  55             indextemplate='pair: %s; mdp option',
  56             parse_node = mdp_parser.parse_option,
  57             objname='mdp option')
  58     app.add_object_type('mdp-value', 'mdp-value',
  59             parse_node = mdp_parser.parse_value,
  60             objname='mdp value')
  61     app.add_object_type('cmake', 'cmake',
  62             indextemplate='pair: %s; cmake option',
  63             objname='CMake cache variable')