Skip to content

Fix doc #85

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
twiggler merged 3 commits into from
Apr 28, 2026
Merged

Fix doc #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
745b4aa
fix: fail on warning
twiggler Apr 28, 2026
f156265
fix: typo
twiggler Apr 28, 2026
e6a734d
Suppress duplicate symbol warnings
twiggler Apr 28, 2026
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
2 changes: 1 addition & 1 deletion dissect/hypervisor/disk/vdi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class VDI:
"""VirtualBox Virtual Disk Image (VDI) implementation.

Use :method:`open` to get a stream for reading from the VDI file. The stream will handle reading
Use :meth:`open` to get a stream for reading from the VDI file. The stream will handle reading
from the parent disk if necessary (and provided).

If provided with a file-like object, the caller is responsible for closing it.
Expand Down
2 changes: 1 addition & 1 deletion tests/_docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?= -jauto
SPHINXOPTS ?= -jauto -w $(BUILDDIR)/warnings.log --fail-on-warning
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = build
Expand Down
6 changes: 5 additions & 1 deletion tests/_docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"show-inheritance",
"show-module-summary",
"special-members",
"imported-members",
]
autoapi_keep_files = True
autoapi_template_dir = "_templates/autoapi"
Expand All @@ -36,3 +35,8 @@
autodoc_member_order = "groupwise"

autosectionlabel_prefix_document = True

suppress_warnings = [
# https://github.com/readthedocs/sphinx-autoapi/issues/285
"autoapi.python_import_resolution",
]
Loading