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