Skip to content

The agent engineering platform.

docs: enable private docstring submembers sphinx (#28589)

Erick Friis1cedf401a7fe
diff --git a/docs/api_reference/conf.py b/docs/api_reference/conf.py
index 3f742b0515..4e01aefcba 100644
--- a/docs/api_reference/conf.py
+++ b/docs/api_reference/conf.py
@@ -87,6 +87,14 @@ class Beta(BaseAdmonition):
def setup(app):
app.add_directive("example_links", ExampleLinksDirective)
app.add_directive("beta", Beta)
+ app.connect('autodoc-skip-member', skip_private_members)
+
+def skip_private_members(app, what, name, obj, skip, options):
+ if skip:
+ return True
+ if hasattr(obj, '__doc__') and obj.__doc__ and ':private:' in obj.__doc__:
+ return True
+ return None
# -- Project information -----------------------------------------------------