[PATCH v2 0/4] Generate documentation links for OE-Core

The purpose of this series is to make links to yocto-docs accessible
from OE-Core through a doclink flag, making the overall documentation
more accessible. This link can be shown with:

  $ bitbake-getvar do_install --value -f doclink
  https://docs.yoctoproject.org/blacksail/ref-manual/tasks.html#term-do_install
  $ bitbake-getvar S --value -f doclink
  https://docs.yoctoproject.org/blacksail/ref-manual/variables.html#term-S

This is made possible through a file generated automatically, which
contains assignments such as:

S[doclink] = 'https://docs.yoctoproject.org/${LAYERSERIES_COMPAT_core}/ref-manual/variables.html#term-S'
do_install[doclink] = 'https://docs.yoctoproject.org/${LAYERSERIES_COMPAT_core}/ref-manual/tasks.html#term-do_install'

This can be used in projects that want to point to documentation, like
Toaster.

This could also be included automatically from OE-Core's bitbake.conf with:

  # Default path to yocto-docs, assuming it is next to the openembedded-core
  # repository, as would be provided by bitbake-setup.
  YOCTO_DOCS_DIR ??= "${COREBASE}/../yocto-docs"

  include ${YOCTO_DOCS_DIR}/documentation/oecore/doclinks.conf

The main point for this is to make documentation for variables easily
accessible, with the hope that this would also encourage people to
contribute to documentation more as it would create a bridge between
OE-Core and yocto-docs.

Signed-off-by: Antonin Godard <[email protected]>
---
Antonin Godard (4):
      ref-manual/tasks.rst: convert to glossaries
      ref-manual/variables.rst: remove flags from variable names
      tools: add gen-doc-links to generate documentation link flags
      .pre-commit-config.yaml: add gen-doc-links

 .pre-commit-config.yaml                            |    7 +
 .../contributor-guide/recipe-style-guide.rst       |   20 +-
 documentation/dev-manual/build-quality.rst         |    2 +-
 documentation/dev-manual/building.rst              |    2 +-
 documentation/dev-manual/debugging.rst             |   32 +-
 documentation/dev-manual/development-shell.rst     |    2 +-
 documentation/dev-manual/devtool.rst               |   14 +-
 documentation/dev-manual/layers.rst                |    6 +-
 documentation/dev-manual/libraries.rst             |    2 +-
 documentation/dev-manual/limiting-resources.rst    |    4 +-
 documentation/dev-manual/multiconfig.rst           |   20 +-
 documentation/dev-manual/new-machine.rst           |    2 +-
 documentation/dev-manual/new-recipe.rst            |   82 +-
 documentation/dev-manual/packages.rst              |    6 +-
 .../dev-manual/python-development-shell.rst        |    2 +-
 documentation/dev-manual/quilt.rst                 |    4 +-
 documentation/dev-manual/speeding-up-build.rst     |    4 +-
 documentation/kernel-dev/common.rst                |   24 +-
 documentation/migration-guides/migration-1.3.rst   |    2 +-
 documentation/migration-guides/migration-1.5.rst   |    4 +-
 documentation/migration-guides/migration-1.6.rst   |    2 +-
 documentation/migration-guides/migration-1.7.rst   |    8 +-
 documentation/migration-guides/migration-1.8.rst   |   10 +-
 documentation/migration-guides/migration-2.1.rst   |   20 +-
 documentation/migration-guides/migration-2.3.rst   |    4 +-
 documentation/migration-guides/migration-2.5.rst   |    2 +-
 documentation/migration-guides/migration-2.6.rst   |    6 +-
 documentation/migration-guides/migration-3.0.rst   |    2 +-
 documentation/migration-guides/migration-3.1.rst   |    2 +-
 documentation/migration-guides/migration-3.2.rst   |   12 +-
 documentation/migration-guides/migration-3.4.rst   |    2 +-
 documentation/migration-guides/migration-4.0.rst   |    6 +-
 documentation/migration-guides/migration-5.1.rst   |   14 +-
 documentation/migration-guides/migration-5.2.rst   |    2 +-
 .../migration-guides/release-notes-3.4.rst         |    2 +-
 .../migration-guides/release-notes-4.2.rst         |    2 +-
 .../migration-guides/release-notes-5.1.rst         |   12 +-
 .../migration-guides/release-notes-5.2.rst         |   14 +-
 .../migration-guides/release-notes-5.3.rst         |    6 +-
 .../migration-guides/release-notes-6.0.rst         |    8 +-
 documentation/oecore/doclinks.conf                 | 1064 ++++++++++++++++++++
 documentation/overview-manual/concepts.rst         |  150 +--
 documentation/ref-manual/classes.rst               |   60 +-
 documentation/ref-manual/devtool-reference.rst     |    2 +-
 documentation/ref-manual/faq.rst                   |    2 +-
 documentation/ref-manual/features.rst              |    4 +-
 documentation/ref-manual/qa-checks.rst             |   30 +-
 documentation/ref-manual/structure.rst             |   12 +-
 documentation/ref-manual/tasks.rst                 | 1056 +++++++++----------
 documentation/ref-manual/terms.rst                 |    6 +-
 documentation/ref-manual/variables.rst             |  114 +--
 documentation/test-manual/intro.rst                |    2 +-
 documentation/test-manual/runtime-testing.rst      |    2 +-
 documentation/tools/gen-doc-links                  |  112 +++
 54 files changed, 2017 insertions(+), 976 deletions(-)
---
base-commit: 358519ca6406a89fee42c45dcaf63a37a374f33c
change-id: 20260708-gen-doc-links-intersphinx-52c33ab9206b