From: "Michael Opdenacker" <michael.opdenacker@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH 1/2] documentation/README: improve BitBake manual referencing guidelines
Date: Tue, 27 Jul 2021 16:11:59 +0200 [thread overview]
Message-ID: <20210727141200.128209-1-michael.opdenacker@bootlin.com> (raw)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/README | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/documentation/README b/documentation/README
index f9e803a28b..1d4d213076 100644
--- a/documentation/README
+++ b/documentation/README
@@ -328,11 +328,15 @@ 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:
-
- See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option
-or
+References to the BitBake manual can be done:
+ - With a specific description instead of the section name:
+ :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
+ - With the section name:
+ ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option
+ - With a BitBake variable name:
:term:`bitbake:BB_NUMBER_PARSE_THREADS`
+ - Linking to the entire BitBake manual:
+ :doc:`BitBake User Manual <bitbake:index>`
Submitting documentation changes
================================
--
2.25.1
next reply other threads:[~2021-07-27 14:12 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-27 14:11 Michael Opdenacker [this message]
2021-07-27 14:12 ` [PATCH 2/2] manuals: simplify references to BitBake manual Michael Opdenacker
2021-07-27 14:14 ` [docs] [PATCH 1/2] documentation/README: improve BitBake manual referencing guidelines Quentin Schulz
2021-07-27 14:29 ` Michael Opdenacker
2021-07-27 15:00 ` Nicolas Dechesne
2021-07-27 16:18 ` Michael Opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210727141200.128209-1-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox