From a2b15cf08f3bd906358873638c7c0db4a201ea59 Mon Sep 17 00:00:00 2001 From: Kan Fu Date: Thu, 21 Nov 2024 14:58:12 -0800 Subject: [PATCH] doc: do not show instance variables of ONC class --- doc/source/conf.py | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index db3fce4..d3f4dbf 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -54,7 +54,7 @@ def skip_rules(app, what, name, obj, skip, options): - # 1. skip aliases in ONC class + # 1. skip aliases and instance_variables in ONC class aliases = [ "getLocationHierarchy", "getDirectByLocation", @@ -68,16 +68,28 @@ def skip_rules(app, what, name, obj, skip, options): ] onc_aliases = {f"onc.ONC.{alias}" for alias in aliases} - if name in onc_aliases: + instance_variables = [ + "token", + "showInfo", + "timeout", + "production", + "outPath", + "discovery", + "delivery", + "archive", + "realTime", + ] + onc_instance_variables = {f"onc.ONC.{var}" for var in instance_variables} + + if name in onc_aliases | onc_instance_variables: skip = True - # 2. skip submodules onc.onc.ONC - if what == "module": + # 2. skip submodules onc.onc.ONC and onc.util + if what == "module" or "util" in name: skip = True return skip def setup(sphinx): - # sphinx.connect("autoapi-skip-member", skip_aliases_in_ONC_class) sphinx.connect("autoapi-skip-member", skip_rules)