summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/README
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake/doc/README')
-rw-r--r--bitbake/doc/README50
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.
15If you want to find HTML versions of the BitBake manuals on the web, 15If you want to find HTML versions of the BitBake manuals on the web,
16go to http://www.openembedded.org/wiki/Documentation. 16go to http://www.openembedded.org/wiki/Documentation.
17 17
18Makefile 18Sphinx
19======== 19======
20 20
21The Makefile processes manual directories to create HTML, PDF, 21The BitBake documentation was migrated from the original DocBook
22tarballs, etc. Details on how the Makefile work are documented 22format to Sphinx based documentation for the Yocto Project 3.2
23inside the Makefile. See that file for more information. 23release.
24 24
25To build a manual, you run the make command and pass it the name 25Additional information related to the Sphinx migration, and guidelines
26of the folder containing the manual's contents. 26for developers willing to contribute to the BitBake documentation can
27For example, the following command run from the documentation directory 27be found in the Yocto Project Documentation README file:
28creates an HTML and a PDF version of the BitBake User Manual.
29The DOC variable specifies the manual you are making:
30 28
31 $ make DOC=bitbake-user-manual 29https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README
32 30
33template 31How to build the Yocto Project documentation
34======== 32============================================
35Contains various templates, fonts, and some old PNG files.
36 33
37tools 34Sphinx is written in Python. While it might work with Python2, for
38===== 35obvious reasons, we will only support building the BitBake
39Contains a tool to convert the DocBook files to PDF format. 36documentation with Python3.
37
38Sphinx might be available in your Linux distro packages repositories,
39however it is not recommend using distro packages, as they might be
40old versions, especially if you are using an LTS version of your
41distro. The recommended method to install Sphinx and all required
42dependencies is to use the Python Package Index (pip).
43
44To install all required packages run:
45
46 $ pip3 install sphinx sphinx_rtd_theme pyyaml
47
48To build the documentation locally, run:
49
50 $ cd documentation
51 $ make -f Makefile.sphinx html
52
53The resulting HTML index page will be _build/html/index.html, and you
54can browse your own copy of the locally generated documentation with
55your browser.