Skip to content

NEW: Ignore line length when line only contains a long URL #132

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

NEW: Ignore line length when line only contains a long URL #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc8fe1d
NEW: Ignore line length when line is only a long URL
carterbox May 30, 2025
a86625c
STY: Fixup line endings
carterbox Jun 2, 2025
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
3 changes: 3 additions & 0 deletions sphinxlint/checkers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,7 @@ def check_missing_final_newline(file, lines, options=None):
_starts_with_directive_or_hyperlink = re.compile(r"^\s*\.\. ").match
_starts_with_anonymous_hyperlink = re.compile(r"^\s*__ ").match
_is_very_long_string_literal = re.compile(r"^\s*``[^`]+``$").match
_is_very_long_inline_link = re.compile(r"^\s*<.*(>`_).?$").match


@checker(".rst", ".po", enabled=False, rst_only=True)
Expand All @@ -439,6 +440,8 @@ def check_line_too_long(file, lines, options=None):
continue # ignore anonymous hyperlink targets
if _is_very_long_string_literal(line):
continue # ignore a very long literal string
if _is_very_long_inline_link(line):
continue # ignore a very long URL on its own line
yield lno + 1, f"Line too long ({len(line) - 1}/{options.max_line_length})"


Expand Down
15 changes: 15 additions & 0 deletions tests/fixtures/xpass/long-inline-link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent rhoncus
volutpat felis, eu egestas sapien tristique a. Vivamus scelerisque nunc nec arcu
pharetra, sit amet feugiat lorem consequat. See this extremely long link here:
`A Very Long Inline Link Example
<https://www.example.com/this-link-is-unusually-long-and-contains-a-lot-of-characters-as-well-as-additional-query-params?param1=value1&param2=value2&param3=value3&more_values=true>`_.

Donec ultrices, nisi sit amet cursus pharetra, arcu lacus tincidunt ligula, eget
fringilla ex turpis vel odio. Curabitur feugiat pretium lorem a fringilla.
Suspendisse eget orci eu sem tincidunt auctor.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent rhoncus
volutpat felis, eu egestas sapien tristique a. Vivamus scelerisque nunc nec
arcu pharetra, sit amet feugiat lorem consequat. See this extremely long
link here: `A Very Long Inline Link Example
<https://www.example.com/this-link-is-unusually-long-and-contains-a-lot-of-characters-as-well-as-additional-query-params?param1=value1&param2=value2&param3=value3&more_values=true>`_.