Fix a few broken references and other warnings in the doc

[simgrid.git] / docs / source / _ext / autodoxy.py

diff --git a/docs/source/_ext/autodoxy.py b/docs/source/_ext/autodoxy.py
index 5811d2a..0a854ca 100644 (file)
--- a/docs/source/_ext/autodoxy.py
+++ b/docs/source/_ext/autodoxy.py
@@ -407,7 +407,7 @@ class DoxygenMethodDocumenter(DoxygenDocumenter):
 
         xpath_query_noparam = ('{:s}/memberdef[@kind="function"]/name[text()="{:s}"]/..').format(prefix, meth)
         xpath_query = ""
-        if self.argsstring != None:
+        if self.argsstring is not None:
             xpath_query = ('{:s}/memberdef[@kind="function" and argsstring/text()="{:s}"]/name[text()="{:s}"]/..').format(prefix,self.argsstring,meth)
         else:
             xpath_query = xpath_query_noparam
@@ -415,7 +415,7 @@ class DoxygenMethodDocumenter(DoxygenDocumenter):
         if not match:
             logger = logging.getLogger(__name__)
 
-            if self.argsstring != None:
+            if self.argsstring is not None:
                 candidates = get_doxygen_root().xpath(xpath_query_noparam)
                 if len(candidates) == 1:
                     logger.warning("[autodoxy] Using method '{}{}{}' instead of '{}{}{}'. You may want to drop your specification of the signature, or to fix it."
@@ -536,16 +536,20 @@ class DoxygenVariableDocumenter(DoxygenDocumenter):
         rtype_el_ref = rtype_el.find('ref')
         if rtype_el_ref is not None:
             rtype = text(rtype_el) + text(rtype_el_ref) + tail(rtype_el_ref)
+#            print(" --> rtype_el: {}    rtype_el_ref: {}".format(text(rtype_el), text(rtype_el_ref)))
         else:
             rtype = rtype_el.text
 
-#        print("rtype: {}".format(rtype))
+        print("rtype: {}".format(rtype))
         signame = (rtype and (rtype + ' ') or '') + self.klassname + "::" + self.objname
-        return fix_namespaces(self.format_template_name() + signame)
+        res = fix_namespaces(self.format_template_name() + signame)
+#        print("formatted name: {}".format(res))
+        return res
 
     def get_doc(self, encoding=None): # This method is called with 1 parameter in Sphinx 2.x and 2 parameters in Sphinx 1.x
         detaileddescription = self.object.find('detaileddescription')
         doc = [format_xml_paragraph(detaileddescription)]
+#        print ("doc: {}".format(doc))
         return doc
 
     def format_template_name(self):