From 878ca9e633fa279a14d4c837f32134527fc243bc Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Wed, 4 May 2022 06:32:01 +0200 Subject: [PATCH 01/10] Restore default role check in `make check`. --- Doc/Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/Makefile b/Doc/Makefile index 3a3417bf99af3b..4e3e7fe5716bb0 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -213,8 +213,8 @@ dist: rm dist/python-$(DISTVERSION)-docs-texinfo.tar check: - $(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst - $(SPHINXLINT) ../Misc/NEWS.d/next/ + $(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst --severity=0 --disable='line too long' + $(SPHINXLINT) ../Misc/NEWS.d/next/ --severity=0 --disable='line too long' serve: @echo "The serve target was removed, use htmlview instead (see bpo-36329)" From c8f769ea5dab5dc0a8551af16ba4223622cae75a Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Wed, 4 May 2022 16:48:18 +0200 Subject: [PATCH 02/10] Options first, then files. --- Doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/Makefile b/Doc/Makefile index 4e3e7fe5716bb0..1b3fb6f654c5b2 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -214,7 +214,7 @@ dist: check: $(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst --severity=0 --disable='line too long' - $(SPHINXLINT) ../Misc/NEWS.d/next/ --severity=0 --disable='line too long' + $(SPHINXLINT) --severity=0 --disable='line too long' ../Misc/NEWS.d/next/ serve: @echo "The serve target was removed, use htmlview instead (see bpo-36329)" From 4bff0b6c1223f3da325315229fa8bd287e0d9abb Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Wed, 4 May 2022 16:48:42 +0200 Subject: [PATCH 03/10] Update `make.bat` too. --- Doc/make.bat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/make.bat b/Doc/make.bat index d9a7aa4ca7fa6c..d06ded52935174 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -180,7 +180,8 @@ if EXIST "%BUILDDIR%\html\index.html" ( goto end :check -cmd /S /C "%SPHINXLINT% -i tools" +cmd /S /C "%SPHINXLINT% -i tools -i README.rst --severity=0 --disable='line too long'" +cmd /S /C "%SPHINXLINT% --severity=0 --disable='line too long' ..\Misc\NEWS.d\next\ " goto end :serve From 57fdf911f06b7a9c92f14045538923238343fc73 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Wed, 4 May 2022 16:53:08 +0200 Subject: [PATCH 04/10] Add a comment explaining the extra options. --- Doc/Makefile | 1 + Doc/make.bat | 1 + 2 files changed, 2 insertions(+) diff --git a/Doc/Makefile b/Doc/Makefile index 1b3fb6f654c5b2..e67a5dd90dc187 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -213,6 +213,7 @@ dist: rm dist/python-$(DISTVERSION)-docs-texinfo.tar check: + # --severity=0 enables all checks, but we don't want to check for long lines $(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst --severity=0 --disable='line too long' $(SPHINXLINT) --severity=0 --disable='line too long' ../Misc/NEWS.d/next/ diff --git a/Doc/make.bat b/Doc/make.bat index d06ded52935174..cd01f8eeceeb06 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -180,6 +180,7 @@ if EXIST "%BUILDDIR%\html\index.html" ( goto end :check +rem --severity=0 enables all checks, but we don't want to check for long lines cmd /S /C "%SPHINXLINT% -i tools -i README.rst --severity=0 --disable='line too long'" cmd /S /C "%SPHINXLINT% --severity=0 --disable='line too long' ..\Misc\NEWS.d\next\ " goto end From 07f76fc4a63d7f288ba0c4d6b2515df23f8c0075 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Wed, 4 May 2022 17:03:25 +0200 Subject: [PATCH 05/10] No reason to ignore the README.rst. --- Doc/Makefile | 2 +- Doc/make.bat | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/Makefile b/Doc/Makefile index e67a5dd90dc187..3dc885940f7eec 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -214,7 +214,7 @@ dist: check: # --severity=0 enables all checks, but we don't want to check for long lines - $(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst --severity=0 --disable='line too long' + $(SPHINXLINT) -i tools -i $(VENVDIR) --severity=0 --disable='line too long' $(SPHINXLINT) --severity=0 --disable='line too long' ../Misc/NEWS.d/next/ serve: diff --git a/Doc/make.bat b/Doc/make.bat index cd01f8eeceeb06..9dd9d6380654a9 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -181,7 +181,7 @@ goto end :check rem --severity=0 enables all checks, but we don't want to check for long lines -cmd /S /C "%SPHINXLINT% -i tools -i README.rst --severity=0 --disable='line too long'" +cmd /S /C "%SPHINXLINT% -i tools --severity=0 --disable='line too long'" cmd /S /C "%SPHINXLINT% --severity=0 --disable='line too long' ..\Misc\NEWS.d\next\ " goto end From 62b74f1f9802fd38c94fd1ed0fb464dedd8a5f64 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sat, 14 May 2022 20:21:20 +0200 Subject: [PATCH 06/10] Enable default-role check in sphinx-lint. Co-authored-by: Julien Palard --- Doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/Makefile b/Doc/Makefile index 3dc885940f7eec..609c42f082ec12 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -214,7 +214,7 @@ dist: check: # --severity=0 enables all checks, but we don't want to check for long lines - $(SPHINXLINT) -i tools -i $(VENVDIR) --severity=0 --disable='line too long' + $(SPHINXLINT) -i tools -i $(VENVDIR) --enable default-role $(SPHINXLINT) --severity=0 --disable='line too long' ../Misc/NEWS.d/next/ serve: From c91e5e5b4231df29b87f4d600792677d7c213854 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sat, 14 May 2022 20:35:52 +0200 Subject: [PATCH 07/10] Update sphinx-lint default-role check. --- Doc/Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/Makefile b/Doc/Makefile index 609c42f082ec12..626f46ad4a5949 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -213,9 +213,9 @@ dist: rm dist/python-$(DISTVERSION)-docs-texinfo.tar check: - # --severity=0 enables all checks, but we don't want to check for long lines + # enable the default-role to make sure it's not used $(SPHINXLINT) -i tools -i $(VENVDIR) --enable default-role - $(SPHINXLINT) --severity=0 --disable='line too long' ../Misc/NEWS.d/next/ + $(SPHINXLINT) --enable default-role ../Misc/NEWS.d/next/ serve: @echo "The serve target was removed, use htmlview instead (see bpo-36329)" From 9e7d291d7a1b751ffec8e380c4b8467f3187555f Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sat, 14 May 2022 20:39:41 +0200 Subject: [PATCH 08/10] Fix use of the default role in the docs. --- Doc/library/datetime.rst | 2 +- Doc/library/enum.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst index e0b28d7cb978d9..bde24ec5f2e11e 100644 --- a/Doc/library/datetime.rst +++ b/Doc/library/datetime.rst @@ -998,7 +998,7 @@ Other constructors, all class methods: ISO 8601 format, with the following exceptions: 1. Time zone offsets may have fractional seconds. - 2. The `T` separator may be replaced by any single unicode character. + 2. The ``T`` separator may be replaced by any single unicode character. 3. Ordinal dates are not currently supported. 4. Fractional hours and minutes are not supported. diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 5829d4617893be..c3256c56c6366f 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -126,11 +126,11 @@ Module Contents :func:`member` - Make `obj` a member. Can be used as a decorator. + Make ``obj`` a member. Can be used as a decorator. :func:`nonmember` - Do not make `obj` a member. Can be used as a decorator. + Do not make ``obj`` a member. Can be used as a decorator. .. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto`` From 4f35bda107d847e8b325379dbec33078f801a794 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sat, 14 May 2022 21:06:27 +0200 Subject: [PATCH 09/10] Update make.bat to check for the default role too. --- Doc/Makefile | 3 ++- Doc/make.bat | 7 ++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Doc/Makefile b/Doc/Makefile index 626f46ad4a5949..8a757a68b6f523 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -213,7 +213,8 @@ dist: rm dist/python-$(DISTVERSION)-docs-texinfo.tar check: - # enable the default-role to make sure it's not used + # Check the docs and NEWS files with sphinx-lint. + # Ignore the tools and venv dirs and check that the default role is not used. $(SPHINXLINT) -i tools -i $(VENVDIR) --enable default-role $(SPHINXLINT) --enable default-role ../Misc/NEWS.d/next/ diff --git a/Doc/make.bat b/Doc/make.bat index 9dd9d6380654a9..d5a5c90de6cea3 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -180,9 +180,10 @@ if EXIST "%BUILDDIR%\html\index.html" ( goto end :check -rem --severity=0 enables all checks, but we don't want to check for long lines -cmd /S /C "%SPHINXLINT% -i tools --severity=0 --disable='line too long'" -cmd /S /C "%SPHINXLINT% --severity=0 --disable='line too long' ..\Misc\NEWS.d\next\ " +rem Check the docs and NEWS files with sphinx-lint. +rem Ignore the tools and venv dirs and check that the default role is not used. +cmd /S /C "%SPHINXLINT% -i tools --enable default-role" +cmd /S /C "%SPHINXLINT% --enable default-role ..\Misc\NEWS.d\next\ " goto end :serve From 4ca9ce9a660c19fae279b3c0bc744b3dcfa77e9e Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sun, 15 May 2022 07:34:53 +0200 Subject: [PATCH 10/10] Fix comment in make.bat. --- Doc/make.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/make.bat b/Doc/make.bat index d5a5c90de6cea3..4f0b3c11f4facb 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -181,7 +181,7 @@ goto end :check rem Check the docs and NEWS files with sphinx-lint. -rem Ignore the tools and venv dirs and check that the default role is not used. +rem Ignore the tools dir and check that the default role is not used. cmd /S /C "%SPHINXLINT% -i tools --enable default-role" cmd /S /C "%SPHINXLINT% --enable default-role ..\Misc\NEWS.d\next\ " goto end