diff mbox series

manuals: replace unnecessary uses of 'yocto_docs' by internal references

Message ID 20230208203601.109671-1-michael.opdenacker@bootlin.com
State Accepted
Commit 0beff9dea986a2ea4b496180b29a99490416eeeb
Headers show
Series manuals: replace unnecessary uses of 'yocto_docs' by internal references | expand

Commit Message

Michael Opdenacker Feb. 8, 2023, 8:36 p.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

These :yocto_docs: references were making external references
to another section of the manual, using the https://docs.yoctoproject.org
website. It's actually better to use internal references (:doc: for an
entire document, and :ref: for a specific section, as they will cause
an error in Sphinx if one day they are no longer valid.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/ref-manual/resources.rst            | 2 +-
 documentation/ref-manual/variables.rst            | 2 +-
 documentation/test-manual/reproducible-builds.rst | 4 ++--
 3 files changed, 4 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 5a09909c70..d2344e39a0 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -173,7 +173,7 @@  Here is a list of resources you might find helpful:
 -  :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked
    questions and their answers.
 
--  :yocto_docs:`Release Information </migration-guides/>`:
+-  :doc:`Release Information </migration-guides/index>`:
    Migration guides, release notes, new features, updates and known issues
    for the current and past releases of the Yocto Project.
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index edc3aa6523..73a9975905 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8481,7 +8481,7 @@  system and gives an overview of their function and contents.
          responsibility to ensure that the toolchain is compatible with the
          default toolchain. Using older or newer versions of these
          components might cause build problems. See
-         :yocto_docs:`Release Information </migration-guides/>` for your
+         :doc:`Release Information </migration-guides/index>` for your
          version of the Yocto Project, to find the specific components with
          which the toolchain must be compatible.
 
diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst
index 2a2f7790d2..50256fb197 100644
--- a/documentation/test-manual/reproducible-builds.rst
+++ b/documentation/test-manual/reproducible-builds.rst
@@ -24,8 +24,8 @@  reproducibility matters. The primary focus of the project is the ability to
 detect security issues being introduced. However, from a Yocto Project
 perspective, it is also hugely important that our builds are deterministic. When
 you build a given input set of metadata, we expect you to get consistent output.
-This has always been a key focus but, :yocto_docs:`since release 3.1 ("dunfell")
-</ref-manual/migration-3.1.html#reproducible-builds-now-enabled-by-default>`,
+This has always been a key focus but, :ref:`since release 3.1 ("dunfell")
+<migration-guides/migration-3.1:reproducible builds now enabled by default>`,
 it is now true down to the binary level including timestamps.
 
 For example, at some point in the future life of a product, you find that you