mbox series

[0/2] be consistent across all local :doc: references

Message ID 20250618-doc-abs-path-v1-0-9f62e0ac92d2@cherry.de
Headers show
Series be consistent across all local :doc: references | expand

Message

Quentin Schulz June 18, 2025, 3:13 p.m. UTC 
The doc directive[1] allows multiple paths:
 - relative to the current document
 - relative to the current document going through the parent directory
   (e.g. via ../)
 - "absolute" (paths starting with /), relative to the root directory
   (which is documentation/ for yocto-docs),

This attempts at making the use of local :doc: directive consistent
across the whole tree by changing (and encouraging) all paths to be
"absolute" paths.

meld doesn't report any change in the HTML output after this series
applied.

[1] https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (2):
      tree-wide: make the :doc: directive use absolute paths
      document how to use :doc: directive

 documentation/README                                      | 10 ++++++++++
 documentation/bsp-guide/bsp.rst                           |  4 ++--
 documentation/contributor-guide/submit-changes.rst        |  4 ++--
 documentation/dev-manual/building.rst                     |  4 ++--
 documentation/dev-manual/debugging.rst                    |  4 ++--
 documentation/dev-manual/new-recipe.rst                   |  2 +-
 documentation/dev-manual/start.rst                        |  2 +-
 documentation/dev-manual/vulnerabilities.rst              |  2 +-
 documentation/migration-guides/release-notes-4.3.rst      |  4 ++--
 documentation/overview-manual/development-environment.rst |  6 +++---
 documentation/ref-manual/resources.rst                    |  4 ++--
 documentation/ref-manual/system-requirements.rst          |  2 +-
 documentation/ref-manual/variables.rst                    |  2 +-
 documentation/standards.md                                | 11 ++++++++++-
 documentation/transitioning-to-a-custom-environment.rst   |  4 ++--
 documentation/what-i-wish-id-known.rst                    |  4 ++--
 16 files changed, 44 insertions(+), 25 deletions(-)
---
base-commit: b13bccbf3fb1890ac428a396f8c5081057edf555
change-id: 20250618-doc-abs-path-572e8275517d

Best regards,