[1/3] docs: ref-manual: ref-variables: fix one-letter pointer links in glossary

Submitted by Quentin Schulz on Oct. 3, 2020, 8:23 a.m. | Patch ID: 176949

Details

Message ID 20201003082336.55703-1-foss@0leil.net
State New
Headers show

Commit Message

Quentin Schulz Oct. 3, 2020, 8:23 a.m.
Since the move to sphinx, variables aren't linked with var- anchors but
term-.

Let's fix that so clicking on a letter will bring to the correct variable
in the page.

Signed-off-by: Quentin Schulz <foss@0leil.net>
---
 documentation/ref-manual/ref-variables.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 2d6719df1..e238b1247 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -7,14 +7,14 @@  Variables Glossary
 This chapter lists common variables used in the OpenEmbedded build
 system and gives an overview of their function and contents.
 
-`A <#var-ABIEXTENSION>`__ :term:`B` `C <#var-CACHE>`__
-:term:`D` `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__
-`G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__
-`K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__
-`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ :term:`P`
-`R <#var-RANLIB>`__ :term:`S` :term:`T`
-`U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__
-`W <#var-WARN_QA>`__ `X <#var-XSERVER>`__
+:term:`A <ABIEXTENSION>` :term:`B` :term:`C <CACHE>`
+:term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FEATURE_PACKAGES>`
+:term:`G <GCCPIE>` :term:`H <HOMEPAGE>` :term:`I <ICECC_DISABLED>`
+:term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
+:term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
+:term:`R <RANLIB>` :term:`S` :term:`T`
+:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>`
+:term:`W <WARN_QA>` :term:`X <XSERVER>`
 
 .. glossary::
 

Comments

Nicolas Dechesne Oct. 3, 2020, 9:20 a.m.
On Sat, Oct 3, 2020 at 10:23 AM Quentin Schulz <foss@0leil.net> wrote:
>
> Since the move to sphinx, variables aren't linked with var- anchors but
> term-.
>
> Let's fix that so clicking on a letter will bring to the correct variable
> in the page.
>
> Signed-off-by: Quentin Schulz <foss@0leil.net>
> ---
>  documentation/ref-manual/ref-variables.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
> index 2d6719df1..e238b1247 100644
> --- a/documentation/ref-manual/ref-variables.rst
> +++ b/documentation/ref-manual/ref-variables.rst
> @@ -7,14 +7,14 @@ Variables Glossary
>  This chapter lists common variables used in the OpenEmbedded build
>  system and gives an overview of their function and contents.
>
> -`A <#var-ABIEXTENSION>`__ :term:`B` `C <#var-CACHE>`__
> -:term:`D` `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__
> -`G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__
> -`K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__
> -`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ :term:`P`
> -`R <#var-RANLIB>`__ :term:`S` :term:`T`
> -`U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__
> -`W <#var-WARN_QA>`__ `X <#var-XSERVER>`__
> +:term:`A <ABIEXTENSION>` :term:`B` :term:`C <CACHE>`
> +:term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FEATURE_PACKAGES>`
> +:term:`G <GCCPIE>` :term:`H <HOMEPAGE>` :term:`I <ICECC_DISABLED>`
> +:term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
> +:term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
> +:term:`R <RANLIB>` :term:`S` :term:`T`
> +:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>`
> +:term:`W <WARN_QA>` :term:`X <XSERVER>`

thanks. it's a good cleanup.. I am pretty sure I did it at some
point.. but i guess i never pushed it.
though i remember wondering whether we should just delete that
completely, since chances are that it won't be well maintained.. and
we have the global index anyways
https://docs.yoctoproject.org/genindex.html

alternatively, if it's really useful we could write a small extension
to generate it, that shouldn't be too hard.

>
>  .. glossary::
>
> --
> 2.26.2
>
>
> 
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#415): https://lists.yoctoproject.org/g/docs/message/415
Mute This Topic: https://lists.yoctoproject.org/mt/77277839/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-