blob: d4f56afa37ca1f42cbcabe549aa2f7d38ae822ac [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001Documentation
2=============
3
4This is the directory that contains the BitBake documentation.
5
6Manual Organization
7===================
8
9Folders exist for individual manuals as follows:
10
Andrew Geissler9aee5002022-03-30 16:27:02 +000011* bitbake-user-manual --- The BitBake User Manual
Patrick Williamsc124f4f2015-09-15 14:41:29 -050012
13Each folder is self-contained regarding content and figures.
14
15If you want to find HTML versions of the BitBake manuals on the web,
Andrew Geisslereff27472021-10-29 15:35:00 -050016go to https://www.openembedded.org/wiki/Documentation.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050017
Andrew Geisslerf0343792020-11-18 10:42:21 -060018Sphinx
19======
Patrick Williamsc124f4f2015-09-15 14:41:29 -050020
Andrew Geisslerf0343792020-11-18 10:42:21 -060021The BitBake documentation was migrated from the original DocBook
22format to Sphinx based documentation for the Yocto Project 3.2
23release.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050024
Andrew Geisslerf0343792020-11-18 10:42:21 -060025Additional 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:
Patrick Williamsc124f4f2015-09-15 14:41:29 -050028
Andrew Geisslerf0343792020-11-18 10:42:21 -060029https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README
Patrick Williamsc124f4f2015-09-15 14:41:29 -050030
Andrew Geisslerf0343792020-11-18 10:42:21 -060031How to build the Yocto Project documentation
32============================================
Patrick Williamsc124f4f2015-09-15 14:41:29 -050033
Andrew Geisslerf0343792020-11-18 10:42:21 -060034Sphinx 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
Andrew Geissler5082cc72023-09-11 08:41:39 -040050 $ cd doc
51 $ make html
Andrew Geisslerf0343792020-11-18 10:42:21 -060052
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.