docs/source/_ext/autodoxy.py

   1 """
   2 This is autodoxy, a sphinx extension providing autodoc-like directives
   3 that are feed with Doxygen files.
   4
   5 It is highly inspired from the autodoc_doxygen sphinx extension, but
   6 adapted to my own needs in SimGrid.
   7 https://github.com/rmcgibbo/sphinxcontrib-autodoc_doxygen
   8
   9 Licence: MIT
  10 Copyright (c) 2015 Robert T. McGibbon
  11 Copyright (c) 2019 Martin Quinson
  12 """
  13 from __future__ import print_function, absolute_import, division
  14
  15 import os.path
  16 import re
  17 import sys
  18
  19 from six import itervalues
  20 from lxml import etree as ET
  21 from sphinx.ext.autodoc import Documenter, members_option, ALL
  22 try:
  23     from sphinx.ext.autodoc import AutoDirective
  24     sphinxVersion = 1
  25 except ImportError:
  26     sphinxVersion = 2
  27 from sphinx.errors import ExtensionError
  28 from sphinx.util import logging
  29
  30
  31 ##########################################################################
  32 # XML utils
  33 ##########################################################################
  34 def format_xml_paragraph(xmlnode):
  35     """Format an Doxygen XML segment (principally a detaileddescription)
  36     as a paragraph for inclusion in the rst document
  37
  38     Parameters
  39     ----------
  40     xmlnode
  41
  42     Returns
  43     -------
  44     lines
  45         A list of lines.
  46     """
  47     return [l.rstrip() for l in _DoxygenXmlParagraphFormatter().generic_visit(xmlnode).lines]
  48
  49
  50 class _DoxygenXmlParagraphFormatter(object):
  51     # This class follows the model of the stdlib's ast.NodeVisitor for tree traversal
  52     # where you dispatch on the element type to a different method for each node
  53     # during the traverse.
  54
  55     # It's supposed to handle paragraphs, references, preformatted text (code blocks), and lists.
  56
  57     def __init__(self):
  58         self.lines = ['']
  59         self.continue_line = False
  60
  61     def visit(self, node):
  62         method = 'visit_' + node.tag
  63         visitor = getattr(self, method, self.generic_visit)
  64         return visitor(node)
  65
  66     def generic_visit(self, node):
  67         for child in node.getchildren():
  68             self.visit(child)
  69         return self
  70
  71     def visit_ref(self, node):
  72         ref = get_doxygen_root().findall('.//*[@id="%s"]' % node.get('refid'))
  73         if ref:
  74             ref = ref[0]
  75             if ref.tag == 'memberdef':
  76                 parent = ref.xpath('./ancestor::compounddef/compoundname')[0].text
  77                 name = ref.find('./name').text
  78                 real_name = parent + '::' + name
  79             elif ref.tag in ('compounddef', 'enumvalue'):
  80                 name_node = ref.find('./name')
  81                 real_name = name_node.text if name_node is not None else ''
  82             else:
  83                 raise NotImplementedError(ref.tag)
  84         else:
  85             real_name = None
  86
  87         val = [':cpp:any:`', node.text]
  88         if real_name:
  89             val.extend((' <', real_name, '>`'))
  90         else:
  91             val.append('`')
  92         if node.tail is not None:
  93             val.append(node.tail)
  94
  95         self.lines[-1] += ''.join(val)
  96
  97     def visit_para(self, node):
  98         if node.text is not None:
  99             if self.continue_line:
 100                 self.lines[-1] += node.text
 101             else:
 102                 self.lines.append(node.text)
 103         self.generic_visit(node)
 104         self.lines.append('')
 105         self.continue_line = False
 106
 107     def visit_verbatim(self, node):
 108         if node.text is not None:
 109             # remove the leading ' *' of any lines
 110             lines = [re.sub('^\s*\*','', l) for l in node.text.split('\n')]
 111             # Merge each paragraph together
 112             text = re.sub("\n\n", "PaRaGrraphSplit", '\n'.join(lines))
 113             text = re.sub('\n', '', text)
 114             lines = text.split('PaRaGrraphSplit')
 115
 116             # merge content to the built doc
 117             if self.continue_line:
 118                 self.lines[-1] += lines[0]
 119                 lines = lines[1:]
 120             for l in lines:
 121                 self.lines.append('')
 122                 self.lines.append(l)
 123         self.generic_visit(node)
 124         self.lines.append('')
 125         self.continue_line = False
 126
 127     def visit_parametername(self, node):
 128         if 'direction' in node.attrib:
 129             direction = '[%s] ' % node.get('direction')
 130         else:
 131             direction = ''
 132
 133         self.lines.append('**%s** -- %s' % (
 134             node.text, direction))
 135         self.continue_line = True
 136
 137     def visit_parameterlist(self, node):
 138         lines = [l for l in type(self)().generic_visit(node).lines if l != '']
 139         self.lines.extend([':parameters:', ''] + ['* %s' % l for l in lines] + [''])
 140
 141     def visit_simplesect(self, node):
 142         if node.get('kind') == 'return':
 143             self.lines.append(':returns: ')
 144             self.continue_line = True
 145         self.generic_visit(node)
 146
 147     def visit_listitem(self, node):
 148         self.lines.append('   - ')
 149         self.continue_line = True
 150         self.generic_visit(node)
 151
 152     def visit_preformatted(self, node):
 153         segment = [node.text if node.text is not None else '']
 154         for n in node.getchildren():
 155             segment.append(n.text)
 156             if n.tail is not None:
 157                 segment.append(n.tail)
 158
 159         lines = ''.join(segment).split('\n')
 160         self.lines.extend(('.. code-block:: C++', ''))
 161         self.lines.extend(['  ' + l for l in lines])
 162
 163     def visit_computeroutput(self, node):
 164         c = node.find('preformatted')
 165         if c is not None:
 166             return self.visit_preformatted(c)
 167         return self.visit_preformatted(node)
 168
 169     def visit_xrefsect(self, node):
 170         if node.find('xreftitle').text == 'Deprecated':
 171             sublines = type(self)().generic_visit(node).lines
 172             self.lines.extend(['.. admonition:: Deprecated'] + ['   ' + s for s in sublines])
 173         else:
 174             raise ValueError(node)
 175
 176     def visit_subscript(self, node):
 177         self.lines[-1] += '\ :sub:`%s` %s' % (node.text, node.tail)
 178
 179
 180 ##########################################################################
 181 # Directives
 182 ##########################################################################
 183
 184
 185 class DoxygenDocumenter(Documenter):
 186     # Variables to store the names of the object being documented. modname and fullname are redundant,
 187     # and objpath is always the empty list. This is inelegant, but we need to work with the superclass.
 188
 189     fullname = None  # example: "OpenMM::NonbondedForce" or "OpenMM::NonbondedForce::methodName""
 190     modname = None   # example: "OpenMM::NonbondedForce" or "OpenMM::NonbondedForce::methodName""
 191     objname = None   # example: "NonbondedForce"  or "methodName"
 192     objpath = []     # always the empty list
 193     object = None    # the xml node for the object
 194
 195     option_spec = {
 196         'members': members_option,
 197     }
 198
 199     def __init__(self, directive, name, indent=u'', my_id = None):
 200         super(DoxygenDocumenter, self).__init__(directive, name, indent)
 201         if my_id is not None:
 202             self.parse_id(my_id)
 203
 204     def parse_id(self, id_to_parse):
 205         return False
 206
 207     def parse_name(self):
 208         """Determine what module to import and what attribute to document.
 209         Returns True and sets *self.modname*, *self.objname*, *self.fullname*,
 210         if parsing and resolving was successful.
 211         """
 212         # To view the context and order in which all of these methods get called,
 213         # See, Documenter.generate(). That's the main "entry point" that first
 214         # calls parse_name(), follwed by import_object(), format_signature(),
 215         # add_directive_header(), and then add_content() (which calls get_doc())
 216
 217         # If we were provided a prototype, that must be an overloaded function. Save it.
 218         self.argsstring = None
 219         if "(" in self.name:
 220             (self.name, self.argsstring) = self.name.split('(', 1)
 221             self.argsstring = "({}".format(self.argsstring)
 222
 223         # methods in the superclass sometimes use '.' to join namespace/class
 224         # names with method names, and we don't want that.
 225         self.name = self.name.replace('.', '::')
 226         self.fullname = self.name
 227         self.modname = self.fullname
 228         self.objpath = []
 229
 230         if '::' in self.name:
 231             parts = self.name.split('::')
 232             self.klassname = parts[-2]
 233             self.objname = parts[-1]
 234         else:
 235             self.objname = self.name
 236             self.klassname = ""
 237
 238         return True
 239
 240     def add_directive_header(self, sig):
 241         """Add the directive header and options to the generated content."""
 242         domain = getattr(self, 'domain', 'cpp')
 243         directive = getattr(self, 'directivetype', self.objtype)
 244         name = self.format_name()
 245         sourcename = self.get_sourcename()
 246         #print('.. %s:%s:: %s%s' % (domain, directive, name, sig))
 247         self.add_line(u'.. %s:%s:: %s%s' % (domain, directive, name, sig),
 248                       sourcename)
 249
 250     def document_members(self, all_members=False):
 251         """Generate reST for member documentation.
 252         If *all_members* is True, do all members, else those given by
 253         *self.options.members*.
 254         """
 255         want_all = all_members or self.options.inherited_members or \
 256             self.options.members is ALL
 257         # find out which members are documentable
 258         members_check_module, members = self.get_object_members(want_all)
 259
 260         # remove members given by exclude-members
 261         if self.options.exclude_members:
 262             members = [(membername, member) for (membername, member) in members
 263                        if membername not in self.options.exclude_members]
 264
 265         # document non-skipped members
 266         memberdocumenters = []
 267         for (mname, member, isattr) in self.filter_members(members, want_all):
 268             if sphinxVersion >= 2:
 269                 classes = [cls for cls in itervalues(self.env.app.registry.documenters)
 270                             if cls.can_document_member(member, mname, isattr, self)]
 271             else:
 272                 classes = [cls for cls in itervalues(AutoDirective._registry)
 273                             if cls.can_document_member(member, mname, isattr, self)]
 274             if not classes:
 275                 # don't know how to document this member
 276                 continue
 277
 278             # prefer the documenter with the highest priority
 279             classes.sort(key=lambda cls: cls.priority)
 280
 281             documenter = classes[-1](self.directive, mname, indent=self.indent, id=member.get('id'))
 282             memberdocumenters.append((documenter, isattr))
 283
 284         for documenter, isattr in memberdocumenters:
 285             documenter.generate(
 286                 all_members=True, real_modname=self.real_modname,
 287                 check_module=members_check_module and not isattr)
 288
 289         # reset current objects
 290         self.env.temp_data['autodoc:module'] = None
 291         self.env.temp_data['autodoc:class'] = None
 292
 293
 294 class DoxygenClassDocumenter(DoxygenDocumenter):
 295     objtype = 'doxyclass'
 296     directivetype = 'class'
 297     domain = 'cpp'
 298     priority = 100
 299
 300     option_spec = {
 301         'members': members_option,
 302     }
 303
 304     @classmethod
 305     def can_document_member(cls, member, membername, isattr, parent):
 306         # this method is only called from Documenter.document_members
 307         # when a higher level documenter (module or namespace) is trying
 308         # to choose the appropriate documenter for each of its lower-level
 309         # members. Currently not implemented since we don't have a higher-level
 310         # doumenter like a DoxygenNamespaceDocumenter.
 311         return False
 312
 313     def import_object(self):
 314         """Import the object and set it as *self.object*.  In the call sequence, this
 315         is executed right after parse_name(), so it can use *self.fullname*, *self.objname*,
 316         and *self.modname*.
 317
 318         Returns True if successful, False if an error occurred.
 319         """
 320         xpath_query = './/compoundname[text()="%s"]/..' % self.fullname
 321         match = get_doxygen_root().xpath(xpath_query)
 322         if len(match) != 1:
 323             raise ExtensionError('[autodoxy] could not find class (fullname="%s"). I tried '
 324                                  'the following xpath: "%s"' % (self.fullname, xpath_query))
 325
 326         self.object = match[0]
 327         return True
 328
 329     def format_signature(self):
 330         return ''
 331
 332     def format_name(self):
 333         return self.fullname
 334
 335     def get_doc(self, encoding=None): # This method is called with 1 parameter in Sphinx 2.x and 2 parameters in Sphinx 1.x
 336         detaileddescription = self.object.find('detaileddescription')
 337         doc = [format_xml_paragraph(detaileddescription)]
 338         return doc
 339
 340     def get_object_members(self, want_all):
 341         all_members = self.object.xpath('.//sectiondef[@kind="public-func" '
 342             'or @kind="public-static-func"]/memberdef[@kind="function"]')
 343
 344         if want_all:
 345             return False, ((m.find('name').text, m) for m in all_members)
 346         if not self.options.members:
 347             return False, []
 348         return False, ((m.find('name').text, m) for m in all_members if m.find('name').text in self.options.members)
 349
 350     def filter_members(self, members, want_all):
 351         ret = []
 352         for (membername, member) in members:
 353             ret.append((membername, member, False))
 354         return ret
 355
 356     def document_members(self, all_members=False):
 357         super(DoxygenClassDocumenter, self).document_members(all_members=all_members)
 358         # Uncomment to view the generated rst for the class.
 359         # print('\n'.join(self.directive.result))
 360
 361 class DoxygenMethodDocumenter(DoxygenDocumenter):
 362     objtype = 'doxymethod'
 363     directivetype = 'function'
 364     domain = 'cpp'
 365     priority = 100
 366
 367     @classmethod
 368     def can_document_member(cls, member, membername, isattr, parent):
 369         if ET.iselement(member) and member.tag == 'memberdef' and member.get('kind') == 'function':
 370             return True
 371         return False
 372
 373     def parse_id(self, id_to_parse):
 374         xp = './/*[@id="%s"]' % id_to_parse
 375         match = get_doxygen_root().xpath(xp)
 376         if match:
 377             match = match[0]
 378             self.fullname = match.find('./definition').text.split()[-1]
 379             self.modname = self.fullname
 380             self.objname = match.find('./name').text
 381             self.object = match
 382         return False
 383
 384     def import_object(self):
 385         if ET.iselement(self.object):
 386             # self.object already set from DoxygenDocumenter.parse_name(),
 387             # caused by passing in the `id` of the node instead of just a
 388             # classname or method name
 389             return True
 390
 391         if '::' in self.fullname:
 392             (obj, meth) = self.fullname.rsplit('::', 1)
 393             # 'public-func' and 'public-static-func' are for classes while 'func' alone is for namespaces
 394             prefix = './/compoundname[text()="{:s}"]/../sectiondef[@kind="public-func" or @kind="public-static-func" or @kind="func"]'.format(obj)
 395             obj = "{:s}::".format(obj)
 396         else:
 397             meth = self.fullname
 398             prefix = './'
 399             obj = ''
 400
 401         xpath_query_noparam = ('{:s}/memberdef[@kind="function"]/name[text()="{:s}"]/..').format(prefix, meth)
 402         xpath_query = ""
 403         if self.argsstring != None:
 404             xpath_query = ('{:s}/memberdef[@kind="function" and argsstring/text()="{:s}"]/name[text()="{:s}"]/..').format(prefix,self.argsstring,meth)
 405         else:
 406             xpath_query = xpath_query_noparam
 407         match = get_doxygen_root().xpath(xpath_query)
 408         if not match:
 409             logger = logging.getLogger(__name__)
 410
 411             if self.argsstring != None:
 412                 candidates = get_doxygen_root().xpath(xpath_query_noparam)
 413                 if len(candidates) == 1:
 414                     logger.warning("[autodoxy] Using method '{}{}{}' instead of '{}{}{}'. You may want to drop your specification of the signature, or to fix it."
 415                                        .format(obj, meth, candidates[0].find('argsstring').text, obj, meth, self.argsstring))
 416                     self.object = candidates[0]
 417                     return True
 418                 logger.warning("[autodoxy] WARNING: Could not find method {}{}{}".format(obj, meth, self.argsstring))
 419                 if not candidates:
 420                     logger.warning("[autodoxy] WARNING:  (no candidate found)")
 421                 for cand in candidates:
 422                     logger.warning("[autodoxy] WARNING:   Existing candidate: {}{}{}".format(obj, meth, cand.find('argsstring').text))
 423             else:
 424                 logger.warning("[autodoxy] WARNING: Could not find method {}{} in Doxygen files\nQuery: {}".format(obj, meth, xpath_query))
 425             return False
 426         self.object = match[0]
 427         return True
 428
 429     def get_doc(self, encoding=None): # This method is called with 1 parameter in Sphinx 2.x and 2 parameters in Sphinx 1.x
 430         detaileddescription = self.object.find('detaileddescription')
 431         doc = [format_xml_paragraph(detaileddescription)]
 432         return doc
 433
 434     def format_name(self):
 435         def text(el):
 436             if el.text is not None:
 437                 return el.text
 438             return ''
 439
 440         def tail(el):
 441             if el.tail is not None:
 442                 return el.tail
 443             return ''
 444
 445         rtype_el = self.object.find('type')
 446         rtype_el_ref = rtype_el.find('ref')
 447         if rtype_el_ref is not None:
 448             rtype = text(rtype_el) + text(rtype_el_ref) + tail(rtype_el_ref)
 449         else:
 450             rtype = rtype_el.text
 451
 452  #       print("rtype: {}".format(rtype))
 453         signame = (rtype and (rtype + ' ') or '') + self.klassname + "::"+ self.objname
 454         return self.format_template_name() + signame
 455
 456     def format_template_name(self):
 457         types = [e.text for e in self.object.findall('templateparamlist/param/type')]
 458         if not types:
 459             return ''
 460         ret = 'template <%s>' % ','.join(types)
 461 #        print ("template: {}".format(ret))
 462         return ret
 463
 464     def format_signature(self):
 465         args = self.object.find('argsstring').text
 466         return args
 467
 468     def document_members(self, all_members=False):
 469         pass
 470
 471 class DoxygenVariableDocumenter(DoxygenDocumenter):
 472     objtype = 'doxyvar'
 473     directivetype = 'var'
 474     domain = 'cpp'
 475     priority = 100
 476
 477     @classmethod
 478     def can_document_member(cls, member, membername, isattr, parent):
 479         if ET.iselement(member) and member.tag == 'memberdef' and member.get('kind') == 'variable':
 480             return True
 481         return False
 482
 483     def import_object(self):
 484         if ET.iselement(self.object):
 485             # self.object already set from DoxygenDocumenter.parse_name(),
 486             # caused by passing in the `id` of the node instead of just a
 487             # classname or method name
 488             return True
 489
 490         (obj, var) = self.fullname.rsplit('::', 1)
 491
 492         xpath_query = ('.//compoundname[text()="{:s}"]/../sectiondef[@kind="public-attrib" or @kind="public-static-attrib"]'
 493                        '/memberdef[@kind="variable"]/name[text()="{:s}"]/..').format(obj, var)
 494 #        print("fullname {}".format(self.fullname))
 495         match = get_doxygen_root().xpath(xpath_query)
 496         if not match:
 497             logger = logging.getLogger(__name__)
 498
 499             logger.warning("[autodoxy] WARNING: could not find variable {}::{} in Doxygen files".format(obj, var))
 500             return False
 501         self.object = match[0]
 502         return True
 503
 504     def parse_id(self, id_to_parse):
 505         xp = './/*[@id="%s"]' % id_to_parse
 506         match = get_doxygen_root().xpath(xp)
 507         if match:
 508             match = match[0]
 509             self.fullname = match.find('./definition').text.split()[-1]
 510             self.modname = self.fullname
 511             self.objname = match.find('./name').text
 512             self.object = match
 513         return False
 514
 515     def format_name(self):
 516         def text(el):
 517             if el.text is not None:
 518                 return el.text
 519             return ''
 520
 521         def tail(el):
 522             if el.tail is not None:
 523                 return el.tail
 524             return ''
 525
 526         rtype_el = self.object.find('type')
 527         rtype_el_ref = rtype_el.find('ref')
 528         if rtype_el_ref is not None:
 529             rtype = text(rtype_el) + text(rtype_el_ref) + tail(rtype_el_ref)
 530         else:
 531             rtype = rtype_el.text
 532
 533 #        print("rtype: {}".format(rtype))
 534         signame = (rtype and (rtype + ' ') or '') + self.klassname + "::" + self.objname
 535         return self.format_template_name() + signame
 536
 537     def get_doc(self, encoding=None): # This method is called with 1 parameter in Sphinx 2.x and 2 parameters in Sphinx 1.x
 538         detaileddescription = self.object.find('detaileddescription')
 539         doc = [format_xml_paragraph(detaileddescription)]
 540         return doc
 541
 542     def format_template_name(self):
 543         types = [e.text for e in self.object.findall('templateparamlist/param/type')]
 544         if not types:
 545             return ''
 546         ret = 'template <%s>' % ','.join(types)
 547 #        print ("template: {}".format(ret))
 548         return ret
 549
 550     def document_members(self, all_members=False):
 551         pass
 552
 553
 554 ##########################################################################
 555 # Setup the extension
 556 ##########################################################################
 557 def set_doxygen_xml(app):
 558     """Load all doxygen XML files from the app config variable
 559     `app.config.doxygen_xml` which should be a path to a directory
 560     containing doxygen xml output
 561     """
 562     err = ExtensionError(
 563         '[autodoxy] No doxygen xml output found in doxygen_xml="%s"' % app.config.doxygen_xml)
 564
 565     if not os.path.isdir(app.config.doxygen_xml):
 566         raise err
 567
 568     files = [os.path.join(app.config.doxygen_xml, f)
 569              for f in os.listdir(app.config.doxygen_xml)
 570              if f.lower().endswith('.xml') and not f.startswith('._')]
 571     if not files:
 572         raise err
 573
 574     setup.DOXYGEN_ROOT = ET.ElementTree(ET.Element('root')).getroot()
 575     for current_file in files:
 576         root = ET.parse(current_file).getroot()
 577         for node in root:
 578             setup.DOXYGEN_ROOT.append(node)
 579
 580
 581 def get_doxygen_root():
 582     """Get the root element of the doxygen XML document.
 583     """
 584     if not hasattr(setup, 'DOXYGEN_ROOT'):
 585         setup.DOXYGEN_ROOT = ET.Element("root")  # dummy
 586     return setup.DOXYGEN_ROOT
 587
 588
 589 def setup(app):
 590     import sphinx.ext.autosummary
 591
 592     app.connect("builder-inited", set_doxygen_xml)
 593 #    app.connect("builder-inited", process_generate_options)
 594
 595     app.setup_extension('sphinx.ext.autodoc')
 596 #    app.setup_extension('sphinx.ext.autosummary')
 597
 598     app.add_autodocumenter(DoxygenClassDocumenter)
 599     app.add_autodocumenter(DoxygenMethodDocumenter)
 600     app.add_autodocumenter(DoxygenVariableDocumenter)
 601     app.add_config_value("doxygen_xml", "", True)
 602
 603 #    app.add_directive('autodoxysummary', DoxygenAutosummary)
 604 #    app.add_directive('autodoxyenum', DoxygenAutoEnum)
 605
 606     return {'version': sphinx.__display_version__, 'parallel_read_safe': True}