README
1Documentation
2=============
3
4This is the directory that contains the BitBake documentation.
5
6Manual Organization
7===================
8
9Folders exist for individual manuals as follows:
10
11* bitbake-user-manual --- The BitBake User Manual
12
13Each folder is self-contained regarding content and figures.
14
15If you want to find HTML versions of the BitBake manuals on the web,
16go to https://www.openembedded.org/wiki/Documentation.
17
18Sphinx
19======
20
21The BitBake documentation was migrated from the original DocBook
22format to Sphinx based documentation for the Yocto Project 3.2
23release.
24
25Additional information related to the Sphinx migration, and guidelines
26for developers willing to contribute to the BitBake documentation can
27be found in the Yocto Project Documentation README file:
28
29https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README
30
31How to build the Yocto Project documentation
32============================================
33
34Sphinx is written in Python. While it might work with Python2, for
35obvious reasons, we will only support building the BitBake
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.
56