diff options
author | Jason M. Bills <jason.m.bills@linux.intel.com> | 2021-01-27 22:27:17 +0300 |
---|---|---|
committer | Jason M. Bills <jason.m.bills@linux.intel.com> | 2021-01-27 22:27:17 +0300 |
commit | 98cc5cd6483975b64d80e8323f7f659dd1337d75 (patch) | |
tree | 5fa64e93d57396bc4c76aa3537156205b4b424ac /poky/documentation/README | |
parent | 82dbc15a05125a812c140a3c8cff81c366482229 (diff) | |
parent | 8fc454f9beebdd347403145c991697019a593cff (diff) | |
download | openbmc-98cc5cd6483975b64d80e8323f7f659dd1337d75.tar.xz |
Merge tag '0.29' of ssh://git-amr-1.devtools.intel.com:29418/openbmc-openbmc into update
Diffstat (limited to 'poky/documentation/README')
-rw-r--r-- | poky/documentation/README | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/poky/documentation/README b/poky/documentation/README index fce3cfe17..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. @@ -121,12 +121,19 @@ To install all required packages run: To build the documentation locally, run: $ cd documentation - $ make -f Makefile.sphinx html + $ make html 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. |