From 8355326ffad023d886da163a2a03f6efb7941116 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Thu, 2 Mar 2023 19:40:23 +0100 Subject: manuals: simplify references to the BitBake User Manual - Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/README | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) (limited to 'documentation/README') diff --git a/documentation/README b/documentation/README index c27ed86a33..e8aed86eb4 100644 --- a/documentation/README +++ b/documentation/README @@ -357,13 +357,16 @@ The sphinx.ext.intersphinx extension is enabled by default so that we can cross reference content from other Sphinx based documentation projects, such as the BitBake manual. -References to the BitBake manual can be done: +References to the BitBake manual can directly be done: - With a specific description instead of the section name: - :ref:`Azure Storage fetcher (az://) ` + :ref:`Azure Storage fetcher (az://) ` - With the section name: - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option - - Linking to the entire BitBake manual: - :doc:`BitBake User Manual ` + :ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option + +If you want to refer to an entire document (or chapter) in the BitBake manual, +you have to use the ":doc:" macro with the "bitbake:" prefix: + - :doc:`BitBake User Manual ` + - :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter Note that a reference to a variable (:term:`VARIABLE`) automatically points to the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. @@ -372,6 +375,11 @@ BitBake manual as follows: :term:`bitbake:BB_NUMBER_PARSE_THREADS` +This would be the same if we had identical document filenames in +both the Yocto Project and BitBake manuals: + + :ref:`bitbake:directory/file:section title` + Submitting documentation changes ================================ -- cgit v1.2.3-54-g00ecf