sphinx: ref-variables: use builtin sphinx glossary

Browse Source

Sphinx has a glossary directive. From the documentation:
This directive must contain a reST definition list with terms and
definitions. The definitions will then be referencable with the 'term'
role.

So anywhere in *any* manual, we can do :term:`VAR` to refer to an item
from the glossary, and create a link.

An HTML anchor is created for each term in the glossary, and can be
accessed as:
<link>/ref-variables.html#term-<NAME>

To convert to a glossary, we needed proper indentation (e.g. added 3
spaces to each line)

(From yocto-docs rev: af16cc4233ae9672698cf2fbb7bf0a78e461122e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

...

This commit is contained in:

Nicolas Dechesne

2020-06-26 19:24:06 +02:00

committed by Richard Purdie

parent 9bd69b1f1d

commit 0b84b3dd76

1 changed files with 7899 additions and 7899 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

15798

documentation/ref-manual/ref-variables.rst

File diff suppressed because it is too large Load Diff