DOC Skip @Property on classes in the auto generated API reference (#30989)

betatim · web-flow · commit 1bd24a27498c · 2025-03-17T11:17:38.000+01:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -799,6 +799,15 @@ def disable_plot_gallery_for_linkcheck(app):
         sphinx_gallery_conf["plot_gallery"] = "False"
 
 
+def skip_properties(app, what, name, obj, skip, options):
+    """Skip properties that are fitted attributes"""
+    if isinstance(obj, property):
+        if name.endswith("_") and not name.startswith("_"):
+            return True
+
+    return skip
+
+
 def setup(app):
     # do not run the examples when using linkcheck by using a small priority
     # (default priority is 500 and sphinx-gallery using builder-inited event too)
@@ -811,6 +820,8 @@ def setup(app):
     app.connect("build-finished", make_carousel_thumbs)
     app.connect("build-finished", filter_search_index)
 
+    app.connect("autodoc-skip-member", skip_properties)
+
 
 # The following is used by sphinx.ext.linkcode to provide links to github
 linkcode_resolve = make_linkcode_resolve(
