Use configuration file to ignore irrelevant warning of Sphinx>=7

melexis · Sep 12, 2024 · 8589450 · 8589450
1 parent a5c451f
commit 8589450
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/tox.ini b/tox.ini
@@ -64,7 +64,7 @@ whitelist_externals =
     make
     mlx-warnings
 commands=
-    mlx-warnings --sphinx --exact-warnings 1 --command make -C doc html
+    mlx-warnings --config warnings_config.yml --command make -C doc html
 
 [testenv:sphinx-latest]
 deps=
@@ -77,4 +77,4 @@ whitelist_externals =
     make
     mlx-warnings
 commands=
-    mlx-warnings --sphinx --exact-warnings 1 --command make -C doc html
+    mlx-warnings --config warnings_config.yml --command make -C doc html
diff --git a/warnings_config.yml b/warnings_config.yml
@@ -0,0 +1,18 @@
+sphinx:
+  enabled: true
+  min: 1
+  max: 1
+  exclude:
+    - 'WARNING: cannot cache unpickable configuration value: .traceability_attributes_sort. \(because it contains a function, class, or module object\)'
+doxygen:
+  enabled: false
+junit:
+  enabled: false
+xmlrunner:
+  enabled: false
+coverity:
+  enabled: false
+robot:
+  enabled: false
+polyspace:
+  enabled: false