From e27ee8c2680d85eb8fbb016fa38714e1d2bc8691 Mon Sep 17 00:00:00 2001 From: Trevor Woerner Date: Fri, 23 May 2025 21:49:02 -0400 Subject: sphinx-lint: unbalanced inline literal markup Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 73f4a3e3efce8c4e43939e5053f128faae5b41b1) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard (cherry picked from commit 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/dev-manual/debugging.rst | 2 +- documentation/dev-manual/new-recipe.rst | 2 +- documentation/dev-manual/start.rst | 2 +- documentation/dev-manual/upgrading-recipes.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 92458a0c37..8552b26aea 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst @@ -36,7 +36,7 @@ section: use the BitBake ``-e`` option to examine variable values after a recipe has been parsed. -- ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" +- ":ref:`dev-manual/debugging:viewing package information with ``oe-pkgdata-util```" describes how to use the ``oe-pkgdata-util`` utility to query :term:`PKGDATA_DIR` and display package-related information for built packages. diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index 4a65d70243..9792bd4c1f 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst @@ -56,7 +56,7 @@ necessary when adding a recipe to build a new piece of software to be included in a build. You can find a complete description of the ``devtool add`` command in -the ":ref:`dev-manual/devtool:a closer look at \`\`devtool add\`\``" section +the ":ref:`dev-manual/devtool:a closer look at ``devtool add```" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 21d3dce58c..798bca76ef 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -858,7 +858,7 @@ Initializing the Build Environment ================================== Before you can use Yocto you need to setup the build environment. -From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment +From within the ``poky`` directory, source the :ref:`ref-manual/structure:``oe-init-build-env``` environment setup script to define Yocto Project's build environment on your build host:: $ source oe-init-build-env diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst index 35901a0ea8..2e65678679 100644 --- a/documentation/dev-manual/upgrading-recipes.rst +++ b/documentation/dev-manual/upgrading-recipes.rst @@ -333,7 +333,7 @@ Manually Upgrading a Recipe If for some reason you choose not to upgrade recipes using :ref:`dev-manual/upgrading-recipes:Using the Auto Upgrade Helper (AUH)` or -by :ref:`dev-manual/upgrading-recipes:Using \`\`devtool upgrade\`\``, +by :ref:`dev-manual/upgrading-recipes:Using ``devtool upgrade```, you can manually edit the recipe files to upgrade the versions. .. note:: -- cgit v1.2.3-54-g00ecf