From 1cedf401a7fefa9d97d3265e294c6a97eb0fc03f Mon Sep 17 00:00:00 2001 From: Erick Friis Date: Fri, 6 Dec 2024 13:36:34 -0800 Subject: [PATCH] docs: enable private docstring submembers sphinx (#28589) --- docs/api_reference/conf.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/api_reference/conf.py b/docs/api_reference/conf.py index 3f742b05157..4e01aefcbad 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 -----------------------------------------------------