Skip to content

Resolve duplicate object description warnings #91

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

Open
Miauwkeru wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Resolve duplicate object description warnings #91

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3574da3
Skip generating classes that shadow a module
Miauwkeru Aug 28, 2025
6baa39d
Update the copyright year
Miauwkeru Aug 28, 2025
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
16 changes: 16 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

project = "Dissect"
copyright = "2023, Fox-IT part of NCC Group"
copyright = "2025, Fox-IT part of NCC Group"
author = "Fox-IT part of NCC Group"

# The full version, including alpha/beta/rc tags
Expand Down Expand Up @@ -186,6 +187,21 @@ def autoapi_skip_hook(app: Sphinx, what: str, name: str, obj, skip: bool, option
# Do not skip OS modules in dissect.target (caught by `private-members`)
if name.endswith("._os") and what == "module":
skip = False

# These entries have the issue that certain module or classes get exposed by __all__, however, this shadows a module
# that uses the same name, so we ignore them for now
if (
name
in [
"dissect.qnxfs.c_qnx4",
"dissect.qnxfs.c_qnx6",
"dissect.cstruct.cstruct",
"flow.record.stream",
"dissect.shellitem.lnk.c_lnk",
]
and what != "module"
):
skip = True
return skip


Expand Down