All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/2] documentation/README: improve BitBake manual referencing guidelines
@ 2021-07-27 14:11 Michael Opdenacker
  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
  0 siblings, 2 replies; 6+ messages in thread
From: Michael Opdenacker @ 2021-07-27 14:11 UTC (permalink / raw)
  To: docs; +Cc: Michael Opdenacker

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


^ permalink raw reply related	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-07-27 16:18 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-27 14:11 [PATCH 1/2] documentation/README: improve BitBake manual referencing guidelines Michael Opdenacker
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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.