Skip to content

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

Merged
hugovk merged 2 commits into
sphinx-contrib:mainfrom
carterbox:long-line-url-only
Sep 15, 2025
Merged

NEW: Ignore line length when line only contains a long URL#132
hugovk merged 2 commits into
sphinx-contrib:mainfrom
carterbox:long-line-url-only

Conversation

@carterbox

@carterbox carterbox commented May 30, 2025

Copy link
Copy Markdown
Contributor

Ignores lines whose contents are some whitespace, <, any text, >`_, then an optional punctuation. This allows for long lines to be a URL without breaking them, so that they remain clickable.

For example:

pharetra, sit amet feugiat lorem consequat. `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>`_.
More text here...

xref: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links

Ignores lines whose contents are some whitespace, <, any text,
>`_, then an optional punctuation. This allows for long lines to
be a URL without breaking then, so that they remain clickable.
Comment thread sphinxlint/checkers.py Outdated

@hugovk hugovk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@hugovk hugovk merged commit c41456f into sphinx-contrib:main Sep 15, 2025
21 checks passed
@carterbox carterbox deleted the long-line-url-only branch September 15, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants