diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-10-05 14:08:40 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-10-06 13:52:25 +0100 |
commit | ac8257be721b8f4600d86f2073ce74bfb8fe360d (patch) | |
tree | eb09910566c51a2680de2f84ea888664bed5c26b | |
parent | 25fd9fddc35291a883125bcd2700ea67f4c9749e (diff) | |
download | poky-ac8257be721b8f4600d86f2073ce74bfb8fe360d.tar.gz |
bitbake: docs: update README file after migrationg to Sphinx
(Bitbake rev: ec4c481a0c3a3ccd0ef0832f128afdc047876552)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | bitbake/doc/README | 50 |
1 files changed, 33 insertions, 17 deletions
diff --git a/bitbake/doc/README b/bitbake/doc/README index 303cf8eec7..62595820bd 100644 --- a/bitbake/doc/README +++ b/bitbake/doc/README | |||
@@ -15,25 +15,41 @@ Each folder is self-contained regarding content and figures. | |||
15 | If you want to find HTML versions of the BitBake manuals on the web, | 15 | If you want to find HTML versions of the BitBake manuals on the web, |
16 | go to http://www.openembedded.org/wiki/Documentation. | 16 | go to http://www.openembedded.org/wiki/Documentation. |
17 | 17 | ||
18 | Makefile | 18 | Sphinx |
19 | ======== | 19 | ====== |
20 | 20 | ||
21 | The Makefile processes manual directories to create HTML, PDF, | 21 | The BitBake documentation was migrated from the original DocBook |
22 | tarballs, etc. Details on how the Makefile work are documented | 22 | format to Sphinx based documentation for the Yocto Project 3.2 |
23 | inside the Makefile. See that file for more information. | 23 | release. |
24 | 24 | ||
25 | To build a manual, you run the make command and pass it the name | 25 | Additional information related to the Sphinx migration, and guidelines |
26 | of the folder containing the manual's contents. | 26 | for developers willing to contribute to the BitBake documentation can |
27 | For example, the following command run from the documentation directory | 27 | be found in the Yocto Project Documentation README file: |
28 | creates an HTML and a PDF version of the BitBake User Manual. | ||
29 | The DOC variable specifies the manual you are making: | ||
30 | 28 | ||
31 | $ make DOC=bitbake-user-manual | 29 | https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README |
32 | 30 | ||
33 | template | 31 | How to build the Yocto Project documentation |
34 | ======== | 32 | ============================================ |
35 | Contains various templates, fonts, and some old PNG files. | ||
36 | 33 | ||
37 | tools | 34 | Sphinx is written in Python. While it might work with Python2, for |
38 | ===== | 35 | obvious reasons, we will only support building the BitBake |
39 | Contains a tool to convert the DocBook files to PDF format. | 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 | |||
50 | $ cd documentation | ||
51 | $ make -f Makefile.sphinx html | ||
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. | ||