From 953ab0795243900ccccaaca069d932730a86fc20 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sun, 15 May 2022 17:34:52 +0200 Subject: Restore default role check in `make check`. (#92290) * Restore default role check in `make check`. * Options first, then files. * Update `make.bat` too. * Add a comment explaining the extra options. * No reason to ignore the README.rst. * Enable default-role check in sphinx-lint. Co-authored-by: Julien Palard * Update sphinx-lint default-role check. * Fix use of the default role in the docs. * Update make.bat to check for the default role too. * Fix comment in make.bat. Co-authored-by: Julien Palard --- Doc/Makefile | 6 ++++-- Doc/library/datetime.rst | 2 +- Doc/library/enum.rst | 4 ++-- Doc/make.bat | 5 ++++- 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/Doc/Makefile b/Doc/Makefile index 3a3417b..8a757a6 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -213,8 +213,10 @@ dist: rm dist/python-$(DISTVERSION)-docs-texinfo.tar check: - $(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst - $(SPHINXLINT) ../Misc/NEWS.d/next/ + # 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/ serve: @echo "The serve target was removed, use htmlview instead (see bpo-36329)" diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst index e0b28d7..bde24ec 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 5829d46..c3256c5 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`` diff --git a/Doc/make.bat b/Doc/make.bat index d9a7aa4..4f0b3c1 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -180,7 +180,10 @@ if EXIST "%BUILDDIR%\html\index.html" ( goto end :check -cmd /S /C "%SPHINXLINT% -i tools" +rem Check the docs and NEWS files with sphinx-lint. +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 :serve -- cgit v0.12