diff options
Diffstat (limited to 'poky/documentation/README')
| -rw-r--r-- | poky/documentation/README | 31 |
1 files changed, 22 insertions, 9 deletions
diff --git a/poky/documentation/README b/poky/documentation/README index fe86876ee..b0a3cb1dc 100644 --- a/poky/documentation/README +++ b/poky/documentation/README @@ -34,15 +34,15 @@ Manual Organization Folders exist for individual manuals as follows: -* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide. -* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide -* dev-manual - The Yocto Project Development Tasks Manual -* kernel-dev - The Yocto Project Linux Kernel Development Tasks Manual -* ref-manual - The Yocto Project Reference Manual -* yocto-project-qs - The Yocto Project Quick Start -* profile-manual - The Yocto Project Profile and Tracing Manual -* toaster-manual - The Toaster Manual -* test-manual - The Test Environment Manual +* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide. +* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide +* dev-manual - The Yocto Project Development Tasks Manual +* kernel-dev - The Yocto Project Linux Kernel Development Tasks Manual +* ref-manual - The Yocto Project Reference Manual +* brief-yoctoprojectqs - The Yocto Project Quick Start +* profile-manual - The Yocto Project Profile and Tracing Manual +* toaster-manual - The Toaster Manual +* test-manual - The Test Environment Manual Each folder is self-contained regarding content and figures. @@ -127,6 +127,13 @@ The resulting HTML index page will be _build/html/index.html, and you can browse your own copy of the locally generated documentation with your browser. +Alternatively, you can use Pipenv to automatically install all required +dependencies in a virtual environment: + + $ cd documentation + $ pipenv install + $ pipenv run make html + Sphinx theme and CSS customization ================================== @@ -318,3 +325,9 @@ 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 :term:`bitbake:BB_NUMBER_PARSE_THREADS` + +Submitting documentation changes +================================ + +Please see the top level README file in this repository for details of where +to send patches. |