Fix doc (#85)

* fix: fail on warning

* fix: typo

* Suppress duplicate symbol warnings

Author: twiggler

dissect/hypervisor/disk/vdi.py

@@ -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.

tests/_docs/Makefile

@@ -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

tests/_docs/conf.py

@@ -27,7 +27,6 @@
     "show-inheritance",
     "show-module-summary",
     "special-members",
-    "imported-members",
 ]
 autoapi_keep_files = True
 autoapi_template_dir = "_templates/autoapi"
@@ -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",
+]