diff options
-rw-r--r-- | documentation/README | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README index 6333f0496a..c27ed86a33 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -275,6 +275,19 @@ websites. | |||
275 | More information can be found here: | 275 | More information can be found here: |
276 | https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. | 276 | https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. |
277 | 277 | ||
278 | For external links, we use this syntax: | ||
279 | `link text <link URL>`__ | ||
280 | |||
281 | instead of: | ||
282 | `link text <link URL>`_ | ||
283 | |||
284 | Both syntaxes work, but the latter also creates a "link text" reference | ||
285 | target which could conflict with other references with the same name. | ||
286 | So, only use this variant when you wish to make multiple references | ||
287 | to this link, reusing only the target name. | ||
288 | |||
289 | See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-links-underscore-vs-use | ||
290 | |||
278 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during | 291 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during |
279 | the build and may be broken without knowing about it. | 292 | the build and may be broken without knowing about it. |
280 | 293 | ||