1*4882a593SmuzhiyunDocumentation 2*4882a593Smuzhiyun============= 3*4882a593Smuzhiyun 4*4882a593SmuzhiyunThis is the directory that contains the BitBake documentation. 5*4882a593Smuzhiyun 6*4882a593SmuzhiyunManual Organization 7*4882a593Smuzhiyun=================== 8*4882a593Smuzhiyun 9*4882a593SmuzhiyunFolders exist for individual manuals as follows: 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun* bitbake-user-manual --- The BitBake User Manual 12*4882a593Smuzhiyun 13*4882a593SmuzhiyunEach folder is self-contained regarding content and figures. 14*4882a593Smuzhiyun 15*4882a593SmuzhiyunIf you want to find HTML versions of the BitBake manuals on the web, 16*4882a593Smuzhiyungo to https://www.openembedded.org/wiki/Documentation. 17*4882a593Smuzhiyun 18*4882a593SmuzhiyunSphinx 19*4882a593Smuzhiyun====== 20*4882a593Smuzhiyun 21*4882a593SmuzhiyunThe BitBake documentation was migrated from the original DocBook 22*4882a593Smuzhiyunformat to Sphinx based documentation for the Yocto Project 3.2 23*4882a593Smuzhiyunrelease. 24*4882a593Smuzhiyun 25*4882a593SmuzhiyunAdditional information related to the Sphinx migration, and guidelines 26*4882a593Smuzhiyunfor developers willing to contribute to the BitBake documentation can 27*4882a593Smuzhiyunbe found in the Yocto Project Documentation README file: 28*4882a593Smuzhiyun 29*4882a593Smuzhiyunhttps://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README 30*4882a593Smuzhiyun 31*4882a593SmuzhiyunHow to build the Yocto Project documentation 32*4882a593Smuzhiyun============================================ 33*4882a593Smuzhiyun 34*4882a593SmuzhiyunSphinx is written in Python. While it might work with Python2, for 35*4882a593Smuzhiyunobvious reasons, we will only support building the BitBake 36*4882a593Smuzhiyundocumentation with Python3. 37*4882a593Smuzhiyun 38*4882a593SmuzhiyunSphinx might be available in your Linux distro packages repositories, 39*4882a593Smuzhiyunhowever it is not recommend using distro packages, as they might be 40*4882a593Smuzhiyunold versions, especially if you are using an LTS version of your 41*4882a593Smuzhiyundistro. The recommended method to install Sphinx and all required 42*4882a593Smuzhiyundependencies is to use the Python Package Index (pip). 43*4882a593Smuzhiyun 44*4882a593SmuzhiyunTo install all required packages run: 45*4882a593Smuzhiyun 46*4882a593Smuzhiyun $ pip3 install sphinx sphinx_rtd_theme pyyaml 47*4882a593Smuzhiyun 48*4882a593SmuzhiyunTo build the documentation locally, run: 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun $ cd documentation 51*4882a593Smuzhiyun $ make -f Makefile.sphinx html 52*4882a593Smuzhiyun 53*4882a593SmuzhiyunThe resulting HTML index page will be _build/html/index.html, and you 54*4882a593Smuzhiyuncan browse your own copy of the locally generated documentation with 55*4882a593Smuzhiyunyour browser. 56