tmp fix workaround (relates to PyCQA/doc8#145 and PyCQA/doc8#147)

Ouranosinc · Aug 31, 2023 · 102af33 · 102af33
1 parent 2a1290d
commit 102af33
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -564,8 +564,9 @@ check-security-code-only: mkdir-reports  ## run security checks on source code
 .PHONY: check-docs-only
 check-docs-only: check-doc8-only check-docf-only check-links-only	## run every code documentation checks
 
-# FIXME: temporary workaround (https://github.com/PyCQA/doc8/issues/145)
-# 		configuration somehow not picked up directly from setup.cfg
+# FIXME: temporary workaround (https://github.com/PyCQA/doc8/issues/145 and https://github.com/PyCQA/doc8/issues/147)
+# 		configuration somehow not picked up directly from setup.cfg in python 3.11
+#		setting 'ignore-path-errors' not working without the full path (relative 'docs/changes.rst' fails)
 CHECK_DOC8_XARGS := --ignore-path-errors "$(APP_ROOT)/docs/changes.rst;D000"
 
 .PHONY: check-doc8-only

diff --git a/setup.cfg b/setup.cfg
@@ -37,6 +37,7 @@ universal = 1
 [doc8]
 max-line-length = 120
 ignore-path = docs/_build,docs/autoapi
+ignore-path-errors = docs/changes.rst;D000,
 
 [flake8]
 ignore = E501,W291,W503,W504