diff options
Diffstat (limited to 'documentation/README')
-rw-r--r-- | documentation/README | 15 |
1 files changed, 12 insertions, 3 deletions
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 | |||
328 | so that we can cross reference content from other Sphinx based | 328 | so that we can cross reference content from other Sphinx based |
329 | documentation projects, such as the BitBake manual. | 329 | documentation projects, such as the BitBake manual. |
330 | 330 | ||
331 | References to the bitbake manual can be done like this: | 331 | References to the BitBake manual can be done: |
332 | - With a specific description instead of the section name: | ||
333 | :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` | ||
334 | - With the section name: | ||
335 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option | ||
336 | - Linking to the entire BitBake manual: | ||
337 | :doc:`BitBake User Manual <bitbake:index>` | ||
338 | |||
339 | Note that a reference to a variable (:term:`VARIABLE`) automatically points to | ||
340 | the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. | ||
341 | However, if you need to bypass this, you can explicitely refer to a description in the | ||
342 | BitBake manual as follows: | ||
332 | 343 | ||
333 | See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option | ||
334 | or | ||
335 | :term:`bitbake:BB_NUMBER_PARSE_THREADS` | 344 | :term:`bitbake:BB_NUMBER_PARSE_THREADS` |
336 | 345 | ||
337 | Submitting documentation changes | 346 | Submitting documentation changes |