Skip to content

doc: do not show instance variables of ONC class #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kan-fu merged 1 commit into from
Nov 21, 2024
Merged

doc: do not show instance variables of ONC class #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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)