code.grnet.gr Git - ganeti-local/blob - autotools/docpp

   1 #!/usr/bin/python
   2 #
   3
   4 # Copyright (C) 2011 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21
  22 """Script to replace special directives in documentation.
  23
  24 """
  25
  26 import re
  27 import fileinput
  28
  29 from ganeti import query
  30 from ganeti.build import sphinx_ext
  31
  32
  33 _DOC_RE = re.compile(r"^@(?P<class>[A-Z_]+)_(?P<kind>[A-Z]+)@$")
  34
  35 _DOC_CLASSES_DATA = {
  36   "CONSTANTS": (sphinx_ext.DOCUMENTED_CONSTANTS, sphinx_ext.BuildValuesDoc),
  37   "QUERY_FIELDS": (query.ALL_FIELDS, sphinx_ext.BuildQueryFields),
  38   }
  39
  40
  41 def main():
  42   for line in fileinput.input():
  43     m = _DOC_RE.match(line)
  44     if m:
  45       fields_dict, builder = _DOC_CLASSES_DATA[m.group("class")]
  46       fields = fields_dict[m.group("kind").lower()]
  47       for i in builder(fields):
  48         print i
  49     else:
  50       print line,
  51
  52
  53 if __name__ == "__main__":
  54   main()