From 102af3378771bbbf53bd137027758ee369b3e638 Mon Sep 17 00:00:00 2001 From: Francis Charette Migneault Date: Wed, 30 Aug 2023 21:16:49 -0400 Subject: [PATCH] tmp fix workaround (relates to https://github.com/PyCQA/doc8/issues/145 and https://github.com/PyCQA/doc8/issues/147) --- Makefile | 5 +++-- setup.cfg | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 1611d22d..14c1d4ed 100644 --- 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 index c41e936f..ef4c5095 100644 --- 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