File tree Expand file tree Collapse file tree 1 file changed +6
-7
lines changed
Expand file tree Collapse file tree 1 file changed +6
-7
lines changed Original file line number Diff line number Diff line change @@ -193,20 +193,19 @@ the second mention is more appropriate for a link. Some units are long enough
193193to have a few repeated links. Use judgement to decide when a link will help
194194the reader.
195195
196- We use the `linklint Sphinx extension `__ to suppress two kinds of excessive
197- links: references in a section to itself and duplicate references in a
198- paragraph. Previously, editors had to carefully use an exclamation mark in a
199- Sphinx reference (``:func:`!map` ``) to prevent such links.
200-
201- __ https://pypi.org/project/linklint/
196+ We use the :pypi: `linklint Sphinx extension <linklint> ` to suppress two kinds
197+ of excessive links: references in a section to itself and duplicate references
198+ in a paragraph. Previously, editors had to carefully use an exclamation mark
199+ in a Sphinx reference (``:func:`!map` ``) to prevent such links.
202200
203201Do not use links in section headers. They distract from the title of the
204202section. The term will be mentioned in the paragraph text and can be linked
205203from there.
206204
207205Sphinx automatically adds links to references, and provides a way to
208206suppress the link. Using roles like ``:func:`map` `` will link to the
209- documentation for ``map ``. You can suppress the link while keeping the
207+ documentation for ``map ``. If automatic link suppression isn't enough,
208+ you can suppress the link while keeping the
210209semantic presentation of the function name by adding an exclamation point
211210prefix: ``:func:`!map` ``. See :ref: `roles ` for more details.
212211
You can’t perform that action at this time.
0 commit comments