Merge pull request DIRACGrid#8336 from fstagni/fix_docs_no_autodoc_inherited_pydantic

docs: Prevent documenting inherited Pydantic internals

Author: fstagni

docs/source/conf.py

@@ -108,7 +108,18 @@
 ]
 
 
+def skip_inherited_members(app, what, name, obj, skip, options):
+    removals_list = [
+        "model_json_schema",  # for pydantic.main.BaseModel.model_json_schema
+        "send_error",
+    ]  # for http.server.BaseHTTPRequestHandler.send_error
+    if name in removals_list:
+        return True
+    return skip
+
+
 def setup(app):
+    app.connect("autodoc-skip-member", skip_inherited_members)
     app.add_config_value(
         "recommonmark_config",
         {
@@ -301,7 +312,6 @@ def setup(app):
 # packages that cannot be installed in RTD
 autodoc_mock_imports = DIRAC_DOC_MOCK_LIST
 
-
 # link with the python standard library docs
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),

src/DIRAC/Core/Tornado/Server/TornadoService.py

@@ -73,7 +73,7 @@ def export_streamToClient(self, myDataToSend, token):
     :py:class:`BaseRequestHandler <DIRAC.Core.Tornado.Server.private.BaseRequestHandler.BaseRequestHandler>` for more details.
 
     In order to pass information around and keep some states, we use instance attributes.
-    These are initialized in the :py:meth:`.initialize` method.
+    These are initialized in the ``initialize`` methods.
 
     The handler only define the ``post`` verb. Please refer to :py:meth:`.post` for the details.