diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-06-26 19:24:06 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | 0b84b3dd769d5d4dd3261836eee989da5ff0353b (patch) | |
tree | 153944c6135cae2ca62c92818f872ed7f9a50d6f /documentation/overview-manual/overview-manual-concepts.rst | |
parent | 9bd69b1f1d71a9692189beeac75af9dfbad816cc (diff) | |
download | poky-0b84b3dd769d5d4dd3261836eee989da5ff0353b.tar.gz |
sphinx: ref-variables: use builtin sphinx glossary
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>
Diffstat (limited to 'documentation/overview-manual/overview-manual-concepts.rst')
0 files changed, 0 insertions, 0 deletions