fix docs

fox-it · Feb 17, 2025 · eff81dd · eff81dd
1 parent 97fdfd7
commit eff81dd
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,6 @@ dist/
 *.pyc
 __pycache__/
 .pytest_cache/
-tests/docs/api
-tests/docs/build
+tests/_docs/api
+tests/_docs/build
 .tox/
diff --git a/dissect/eventlog/utils.py b/dissect/eventlog/utils.py
@@ -1,4 +1,6 @@
 class KeyValueCollection(dict):
+    """Eventlog key-value pair collection."""
+
     def __init__(self):
         super().__init__()
         self.idx = {}

diff --git a/tests/data/TestLog-dirty.evt → tests/_data/TestLog-dirty.evt b/tests/data/TestLog-dirty.evt → tests/_data/TestLog-dirty.evt
diff --git a/tests/data/TestLog.evt → tests/_data/TestLog.evt b/tests/data/TestLog.evt → tests/_data/TestLog.evt
diff --git a/tests/data/TestLogX.evtx → tests/_data/TestLogX.evtx b/tests/data/TestLogX.evtx → tests/_data/TestLogX.evtx
diff --git a/tests/docs/Makefile → tests/_docs/Makefile b/tests/docs/Makefile → 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

diff --git a/tests/docs/conf.py → tests/_docs/conf.py b/tests/docs/conf.py → tests/_docs/conf.py
@@ -32,3 +32,8 @@
 autodoc_member_order = "groupwise"
 
 autosectionlabel_prefix_document = True
+
+suppress_warnings = [
+    # https://github.com/readthedocs/sphinx-autoapi/issues/285
+    "autoapi.python_import_resolution",
+]
diff --git a/tests/docs/index.rst → tests/_docs/index.rst b/tests/docs/index.rst → tests/_docs/index.rst
diff --git a/tox.ini b/tox.ini
@@ -68,12 +68,12 @@ deps =
     sphinx-design
     furo
 commands =
-    make -C tests/docs clean
-    make -C tests/docs html
+    make -C tests/_docs clean
+    make -C tests/_docs html
 
 [testenv:docs-linkcheck]
 allowlist_externals = make
 deps = {[testenv:docs-build]deps}
 commands =
-    make -C tests/docs clean
-    make -C tests/docs linkcheck
+    make -C tests/_docs clean
+    make -C tests/_docs linkcheck