The first parameter in the API docs for the interface's methods is incorrectly stripped

[Jun Omae]

• ​https://www.edgewall.org/docs/trac-trunk/html/api/trac_web_api.html#trac.web.api.IRequestHandler.match_request
  • Missing req parameter
• ​https://trac.readthedocs.io/en/latest/api/trac_web_api.html#trac.web.api.IRequestHandler.match_request
  • The API docs outdated but req parameter is not stripped

[Jun Omae]

We could fix it using custom documentater like the following:

doc/conf.py

@@ -372 +372 @@
         return [node], []
     roles.register_canonical_role('extensionpoints', extensionpoints_role)
 
+    import inspect
+    from sphinx.ext import autodoc
+    from sphinx.util.inspect import stringify_signature
+
+    class MethodDocumenter(autodoc.MethodDocumenter):
+
+        def format_args(self, **kwargs):
+            if isinstance(self.parent, type):
+                if any(base.__module__ == 'trac.core' and
+                        base.__name__ == 'Interface'
+                        for base in self.parent.__bases__):
+                    sig = inspect.signature(self.object)
+                    return stringify_signature(sig)
+            return super().format_args(**kwargs)
+
+    app.add_autodocumenter(MethodDocumenter, override=True)
+
     # ifconfig variables
     app.add_config_value('devel', True, '')
     if html_jinja_lexer:

[Jun Omae]

Pushed the changes in [17908] and merged in [17909].