"Linklint is a Sphinx extension that suppresses two kinds of excessive links during the build process: links within a section to the same section and repeated links in a single paragraph."
"The extension examines the doctree of the documentation and modifies references that match criteria for excessiveness, improving clarity and reducing confusion for readers."
"Currently running in the CPython documentation, Linklint has suppressed 3612 links, demonstrating its effectiveness in enhancing the readability of the documentation."
"The concept of suppressing 'obvious' links, such as linking every instance of 'str' to the str() constructor, raises questions about necessity and user understanding."
Linklint is a Sphinx extension designed to suppress excessive links in Python documentation. It originated as a linter for .rst files but evolved to modify the documentation without altering source files. The extension targets two types of excessive links: those linking to the same section and repeated links within a paragraph. Currently implemented in CPython documentation, Linklint has successfully suppressed 3612 links. The idea of suppressing 'obvious' links is debated, with differing opinions on what constitutes an obvious reference.
Read at Ned Batchelder
Unable to calculate read time
Collection
[
|
...
]