mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-20 04:09:20 +00:00
Code Issues 32 Releases Wiki Activity

Refs #36570 -- Added sphinxlint checker to flag unnecessary :py domain in documentation roles.

Browse Source
This commit is contained in:
David Smith 2025-08-27 16:56:37 +02:00 committed by Sarah Boyce
parent 3c0c54351b
commit 05bac8c420
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/lint.py
View File

@ -5,12 +5,14 @@ from os.path import abspath, dirname, splitext
from unittest import mock from unittest import mock
from sphinxlint.checkers import ( from sphinxlint.checkers import (
_ROLE_BODY,
_is_long_interpreted_text, _is_long_interpreted_text,
_is_very_long_string_literal, _is_very_long_string_literal,
_starts_with_anonymous_hyperlink, _starts_with_anonymous_hyperlink,
_starts_with_directive_or_hyperlink, _starts_with_directive_or_hyperlink,
) )
from sphinxlint.checkers import checker as sphinxlint_checker from sphinxlint.checkers import checker as sphinxlint_checker
from sphinxlint.rst import SIMPLENAME
from sphinxlint.sphinxlint import check_text from sphinxlint.sphinxlint import check_text
from sphinxlint.utils import PER_FILE_CACHES, hide_non_rst_blocks from sphinxlint.utils import PER_FILE_CACHES, hide_non_rst_blocks
@ -116,6 +118,24 @@ def check_line_too_long_django(file, lines, options=None):
yield lno + 1, f"Line too long ({len(line) - 1}/{options.max_line_length})" yield lno + 1, f"Line too long ({len(line) - 1}/{options.max_line_length})"
_PYTHON_DOMAIN = re.compile(f":py:{SIMPLENAME}:`{_ROLE_BODY}`")
@sphinxlint_checker(".rst", enabled=False, rst_only=True)
def check_python_domain_in_roles(file, lines, options=None):
"""
:py: indicates the Python language domain. This means code writen in
Python, not Python built-ins in particular.
Bad: :py:class:`email.message.EmailMessage`
Good: :class:`email.message.EmailMessage`
"""
for lno, line in enumerate(lines, start=1):
role = _PYTHON_DOMAIN.search(line)
if role:
yield lno, f":py domain is the default and can be omitted {role.group(0)!r}"
import sphinxlint # noqa: E402 import sphinxlint # noqa: E402
sphinxlint.check_file = django_check_file sphinxlint.check_file = django_check_file