| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1 | Documentation |
| 2 | ============= |
| 3 | |
| 4 | This is the directory that contains the BitBake documentation. |
| 5 | |
| 6 | Manual Organization |
| 7 | =================== |
| 8 | |
| 9 | Folders exist for individual manuals as follows: |
| 10 | |
| Andrew Geissler | 9aee500 | 2022-03-30 16:27:02 +0000 | [diff] [blame] | 11 | * bitbake-user-manual --- The BitBake User Manual |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 12 | |
| 13 | Each folder is self-contained regarding content and figures. |
| 14 | |
| 15 | If you want to find HTML versions of the BitBake manuals on the web, |
| Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 16 | go to https://www.openembedded.org/wiki/Documentation. |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 17 | |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 18 | Sphinx |
| 19 | ====== |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 20 | |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 21 | The BitBake documentation was migrated from the original DocBook |
| 22 | format to Sphinx based documentation for the Yocto Project 3.2 |
| 23 | release. |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 24 | |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 25 | Additional information related to the Sphinx migration, and guidelines |
| 26 | for developers willing to contribute to the BitBake documentation can |
| 27 | be found in the Yocto Project Documentation README file: |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 28 | |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 29 | https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 30 | |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 31 | How to build the Yocto Project documentation |
| 32 | ============================================ |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 33 | |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 34 | Sphinx is written in Python. While it might work with Python2, for |
| 35 | obvious reasons, we will only support building the BitBake |
| 36 | documentation with Python3. |
| 37 | |
| 38 | Sphinx might be available in your Linux distro packages repositories, |
| 39 | however it is not recommend using distro packages, as they might be |
| 40 | old versions, especially if you are using an LTS version of your |
| 41 | distro. The recommended method to install Sphinx and all required |
| 42 | dependencies is to use the Python Package Index (pip). |
| 43 | |
| 44 | To install all required packages run: |
| 45 | |
| 46 | $ pip3 install sphinx sphinx_rtd_theme pyyaml |
| 47 | |
| 48 | To build the documentation locally, run: |
| 49 | |
| Andrew Geissler | 5082cc7 | 2023-09-11 08:41:39 -0400 | [diff] [blame] | 50 | $ cd doc |
| 51 | $ make html |
| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 52 | |
| 53 | The resulting HTML index page will be _build/html/index.html, and you |
| 54 | can browse your own copy of the locally generated documentation with |
| 55 | your browser. |