diff options
| -rw-r--r-- | documentation/README | 43 |
1 files changed, 35 insertions, 8 deletions
diff --git a/documentation/README b/documentation/README index 6f6a8ec842..4d31036e69 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -34,16 +34,18 @@ Manual Organization | |||
| 34 | 34 | ||
| 35 | Here the folders corresponding to individual manuals: | 35 | Here the folders corresponding to individual manuals: |
| 36 | 36 | ||
| 37 | * brief-yoctoprojectqs - Yocto Project Quick Start | ||
| 37 | * overview-manual - Yocto Project Overview and Concepts Manual | 38 | * overview-manual - Yocto Project Overview and Concepts Manual |
| 38 | * sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide. | 39 | * contributor-guide - Yocto Project and OpenEmbedded Contributor Guide |
| 40 | * ref-manual - Yocto Project Reference Manual | ||
| 39 | * bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide | 41 | * bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide |
| 40 | * dev-manual - Yocto Project Development Tasks Manual | 42 | * dev-manual - Yocto Project Development Tasks Manual |
| 41 | * kernel-dev - Yocto Project Linux Kernel Development Manual | 43 | * kernel-dev - Yocto Project Linux Kernel Development Manual |
| 42 | * ref-manual - Yocto Project Reference Manual | ||
| 43 | * brief-yoctoprojectqs - Yocto Project Quick Start | ||
| 44 | * profile-manual - Yocto Project Profiling and Tracing Manual | 44 | * profile-manual - Yocto Project Profiling and Tracing Manual |
| 45 | * sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide. | ||
| 45 | * toaster-manual - Toaster User Manual | 46 | * toaster-manual - Toaster User Manual |
| 46 | * test-manual - Yocto Project Test Environment Manual | 47 | * test-manual - Yocto Project Test Environment Manual |
| 48 | * migration-guides - Yocto Project Release and Migration Notes | ||
| 47 | 49 | ||
| 48 | Each folder is self-contained regarding content and figures. | 50 | Each folder is self-contained regarding content and figures. |
| 49 | 51 | ||
| @@ -129,6 +131,10 @@ Also install the "inkscape" package from your distribution. | |||
| 129 | Inkscape is need to convert SVG graphics to PNG (for EPUB | 131 | Inkscape is need to convert SVG graphics to PNG (for EPUB |
| 130 | export) and to PDF (for PDF export). | 132 | export) and to PDF (for PDF export). |
| 131 | 133 | ||
| 134 | Additionally install "fncychap.sty" TeX font if you want to build PDFs. Debian | ||
| 135 | and Ubuntu have it in "texlive-latex-extra" package while RedHat distributions | ||
| 136 | and OpenSUSE have it in "texlive-fncychap" package for example. | ||
| 137 | |||
| 132 | To build the documentation locally, run: | 138 | To build the documentation locally, run: |
| 133 | 139 | ||
| 134 | $ cd documentation | 140 | $ cd documentation |
| @@ -271,6 +277,19 @@ websites. | |||
| 271 | More information can be found here: | 277 | More information can be found here: |
| 272 | https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. | 278 | https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. |
| 273 | 279 | ||
| 280 | For external links, we use this syntax: | ||
| 281 | `link text <link URL>`__ | ||
| 282 | |||
| 283 | instead of: | ||
| 284 | `link text <link URL>`_ | ||
| 285 | |||
| 286 | Both syntaxes work, but the latter also creates a "link text" reference | ||
| 287 | target which could conflict with other references with the same name. | ||
| 288 | So, only use this variant when you wish to make multiple references | ||
| 289 | to this link, reusing only the target name. | ||
| 290 | |||
| 291 | See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-links-underscore-vs-use | ||
| 292 | |||
| 274 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during | 293 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during |
| 275 | the build and may be broken without knowing about it. | 294 | the build and may be broken without knowing about it. |
| 276 | 295 | ||
| @@ -340,13 +359,16 @@ The sphinx.ext.intersphinx extension is enabled by default | |||
| 340 | so that we can cross reference content from other Sphinx based | 359 | so that we can cross reference content from other Sphinx based |
| 341 | documentation projects, such as the BitBake manual. | 360 | documentation projects, such as the BitBake manual. |
| 342 | 361 | ||
| 343 | References to the BitBake manual can be done: | 362 | References to the BitBake manual can directly be done: |
| 344 | - With a specific description instead of the section name: | 363 | - With a specific description instead of the section name: |
| 345 | :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` | 364 | :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` |
| 346 | - With the section name: | 365 | - With the section name: |
| 347 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option | 366 | :ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option |
| 348 | - Linking to the entire BitBake manual: | 367 | |
| 349 | :doc:`BitBake User Manual <bitbake:index>` | 368 | If you want to refer to an entire document (or chapter) in the BitBake manual, |
| 369 | you have to use the ":doc:" macro with the "bitbake:" prefix: | ||
| 370 | - :doc:`BitBake User Manual <bitbake:index>` | ||
| 371 | - :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter | ||
| 350 | 372 | ||
| 351 | Note that a reference to a variable (:term:`VARIABLE`) automatically points to | 373 | Note that a reference to a variable (:term:`VARIABLE`) automatically points to |
| 352 | the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. | 374 | the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. |
| @@ -355,6 +377,11 @@ BitBake manual as follows: | |||
| 355 | 377 | ||
| 356 | :term:`bitbake:BB_NUMBER_PARSE_THREADS` | 378 | :term:`bitbake:BB_NUMBER_PARSE_THREADS` |
| 357 | 379 | ||
| 380 | This would be the same if we had identical document filenames in | ||
| 381 | both the Yocto Project and BitBake manuals: | ||
| 382 | |||
| 383 | :ref:`bitbake:directory/file:section title` | ||
| 384 | |||
| 358 | Submitting documentation changes | 385 | Submitting documentation changes |
| 359 | ================================ | 386 | ================================ |
| 360 | 387 | ||
