Reference Sphinx AutodocDirective

libsemigroups · Apr 25, 2024 · 8db880a · 8db880a
1 parent b3fbb04
commit 8db880a
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -68,7 +68,14 @@ def fix_overloads(self, content):
         return output
 
     def basic_run(self):
-        """Generate and parse the docstring"""
+        """Generate and parse the docstring
+
+        This is almost identical to AutodocDirective.run(), with the added step
+        that allows for better overloaded functions.
+
+        See:
+        https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/autodoc/directive.py
+        """
         reporter = self.state.document.reporter
 
         try: