Skip to content

sphinx-lint now ignores default roles in docs' make check #92289

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.

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

Closed
ezio-melotti opened this issue May 4, 2022 · 2 comments
Closed

sphinx-lint now ignores default roles in docs' make check #92289

ezio-melotti opened this issue May 4, 2022 · 2 comments
Assignees
Labels
3.11 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@ezio-melotti
Copy link
Member

ezio-melotti commented May 4, 2022

We have a GitHub workflow for documentation that runs make check:

- name: 'Check documentation'
run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" check

make check runs

cpython/Doc/Makefile

Lines 215 to 217 in 7d7a378

check:
$(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst
$(SPHINXLINT) ../Misc/NEWS.d/next/

By default sphinx-lint only reports errors with a severity >=1:
https://github.com/sphinx-contrib/sphinx-lint/blob/b25d09c5a0cf15030c575d18078d815724a1e3e0/sphinxlint.py#L453-L459

The severity of the "default role" check (i.e. making sure that no single `...` are used), was recently changed to severity=0 in sphinx-contrib/sphinx-lint@999b43d.

This means that the use of the default role is no longer caught as an error by make check.

See also #86404.

(Thanks to @AlexWaygood for noticing the issue. cc @JulienPalard)

@ezio-melotti ezio-melotti added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir 3.11 only security fixes 3.10 only security fixes 3.9 only security fixes labels May 4, 2022
@ezio-melotti ezio-melotti self-assigned this May 4, 2022
@erlend-aasland
Copy link
Contributor

Did you land all the backports; can we close this?

@ezio-melotti ezio-melotti removed 3.10 only security fixes 3.9 only security fixes labels May 16, 2022
@ezio-melotti
Copy link
Member Author

Yes, I ported it to 3.11 in #92821 and previous versions were not affected since they used Tools/rstlint.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

2 participants