Skip to content

Restore default role check in make check. #92290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 15, 2022
Merged

Restore default role check in make check. #92290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
878ca9e
Restore default role check in `make check`.
ezio-melotti May 4, 2022
c8f769e
Options first, then files.
ezio-melotti May 4, 2022
4bff0b6
Update `make.bat` too.
ezio-melotti May 4, 2022
57fdf91
Add a comment explaining the extra options.
ezio-melotti May 4, 2022
07f76fc
No reason to ignore the README.rst.
ezio-melotti May 4, 2022
62b74f1
Enable default-role check in sphinx-lint.
ezio-melotti May 14, 2022
c91e5e5
Update sphinx-lint default-role check.
ezio-melotti May 14, 2022
08d05a4
Merge branch 'main' into make-check-default-role
ezio-melotti May 14, 2022
9e7d291
Fix use of the default role in the docs.
ezio-melotti May 14, 2022
4f35bda
Update make.bat to check for the default role too.
ezio-melotti May 14, 2022
4ca9ce9
Fix comment in make.bat.
ezio-melotti May 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/datetime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions Doc/library/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
5 changes: 4 additions & 1 deletion Doc/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down