Skip to content

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

Closed
@ezio-melotti

Description

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)

Metadata

Assignees

Labels

3.11only security fixesdocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions