@@ -134,23 +134,22 @@ Links
134
134
135
135
Linking words to more information about those words is a powerful tool for
136
136
helping people navigate documentation, but links can be over-used.
137
+ Links should be used only if they help the reader.
137
138
138
- Links should be provided only if they help the user. If a link will not help
139
- the user, do not create a link. You may need to suppress a link that Sphinx
140
- would have created automatically.
141
-
142
- Generally, a link should be provided for the first use of a term in a unit, such as a section or paragraph. This
143
- is not a hard and fast rule. Sometimes the second mention is a more
144
- appropriate jumping off point. Some units are long enough to have a few
145
- repeated links. Use judgement to decide if a link would help the reader.
139
+ Generally, a link should be provided for the first use of a term in a unit,
140
+ such as a section or paragraph. This is not a hard and fast rule. Sometimes
141
+ the second mention is more appropriate for a link. Some units are long enough
142
+ to have a few repeated links. Use judgement to decide when a link will help
143
+ the reader.
146
144
147
145
Do not use a link when the link would point to the current unit. It's natural
148
146
to use the name of a function in the documentation for the function, but a link
149
147
on that function name that simply reloads the section the user is already
150
148
reading is useless and distracting.
151
149
152
- Do not use links in section headers. They interrupt the flow, and the term
153
- will be mentioned in the paragraph text so can be linked from there.
150
+ Do not use links in section headers. They distract from the title of the
151
+ section. The term will be mentioned in the paragraph text and can be linked
152
+ from there.
154
153
155
154
Sphinx provides ways to automatically add links to references, and a way to
156
155
suppress the link. Using roles like ``:func:`map` `` will link to the
0 commit comments