From 1452ac11eed0b9a70049901c98587b95412cf0b7 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 27 Jul 2021 16:04:04 +0200 Subject: documentation/README: improve BitBake manual referencing guidelines Removing the ":ref:`-D Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie --- documentation/README | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'documentation/README') diff --git a/documentation/README b/documentation/README index f9e803a28b..fad19683c1 100644 --- a/documentation/README +++ b/documentation/README @@ -328,10 +328,19 @@ 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 like this: +References to the BitBake manual can be done: + - With a specific description instead of the section name: + :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 ` + +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. +However, if you need to bypass this, you can explicitely refer to a description in the +BitBake manual as follows: - See the ":ref:`-D `" option -or :term:`bitbake:BB_NUMBER_PARSE_THREADS` Submitting documentation changes -- cgit v1.2.3-54-g00ecf