fix docs

fox-it · Feb 17, 2025 · a224120 · a224120
1 parent c229db6
commit a224120
Show file tree

Hide file tree

Showing 18 changed files with 35 additions and 10 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+tests/_data/** filter=lfs diff=lfs merge=lfs -text
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/cim/classes.py b/dissect/cim/classes.py
@@ -331,6 +331,8 @@ def key(self) -> InstanceKey:
 
 
 class InstanceKey(dict):
+    """InstanceKey"""
+
     def __getattr__(self, key: str) -> Any:
         return self[key]
 

diff --git a/tests/_data/INDEX.BTR.gz b/tests/_data/INDEX.BTR.gz
diff --git a/tests/_data/MAPPING1.MAP.gz b/tests/_data/MAPPING1.MAP.gz
diff --git a/tests/_data/MAPPING2.MAP.gz b/tests/_data/MAPPING2.MAP.gz
diff --git a/tests/_data/MAPPING3.MAP.gz b/tests/_data/MAPPING3.MAP.gz
diff --git a/tests/_data/OBJECTS.DATA.gz b/tests/_data/OBJECTS.DATA.gz
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
@@ -1,3 +1,5 @@
+project = "dissect.cim"
+
 extensions = [
     "autoapi.extension",
     "sphinx.ext.autodoc",
@@ -32,3 +34,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/tests/conftest.py b/tests/conftest.py
@@ -21,14 +21,14 @@ def open_file_gz(name: str, mode: str = "rb") -> Iterator[gzip.GzipFile]:
 
 @pytest.fixture
 def index_bin() -> Iterator[BinaryIO]:
-    yield from open_file_gz("data/INDEX.BTR.gz")
+    yield from open_file_gz("_data/INDEX.BTR.gz")
 
 
 @pytest.fixture
 def objects_bin() -> Iterator[BinaryIO]:
-    yield from open_file_gz("data/OBJECTS.DATA.gz")
+    yield from open_file_gz("_data/OBJECTS.DATA.gz")
 
 
 @pytest.fixture
 def mappings_bin() -> Iterator[list[BinaryIO]]:
-    yield from zip(*[open_file_gz(f"data/MAPPING{i}.MAP.gz") for i in range(1, 4)])
+    yield from zip(*[open_file_gz(f"_data/MAPPING{i}.MAP.gz") for i in range(1, 4)])
diff --git a/tests/data/INDEX.BTR.gz b/tests/data/INDEX.BTR.gz
diff --git a/tests/data/MAPPING1.MAP.gz b/tests/data/MAPPING1.MAP.gz
diff --git a/tests/data/MAPPING2.MAP.gz b/tests/data/MAPPING2.MAP.gz
diff --git a/tests/data/MAPPING3.MAP.gz b/tests/data/MAPPING3.MAP.gz
diff --git a/tests/data/OBJECTS.DATA.gz b/tests/data/OBJECTS.DATA.gz
diff --git a/tox.ini b/tox.ini
@@ -62,12 +62,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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		tests/_data/** filter=lfs diff=lfs merge=lfs -text