README 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. Documentation
  2. =============
  3. This is the directory that contains the BitBake documentation.
  4. Manual Organization
  5. ===================
  6. Folders exist for individual manuals as follows:
  7. * bitbake-user-manual --- The BitBake User Manual
  8. Each folder is self-contained regarding content and figures.
  9. If you want to find HTML versions of the BitBake manuals on the web,
  10. go to https://www.openembedded.org/wiki/Documentation.
  11. Sphinx
  12. ======
  13. The BitBake documentation was migrated from the original DocBook
  14. format to Sphinx based documentation for the Yocto Project 3.2
  15. release.
  16. Additional information related to the Sphinx migration, and guidelines
  17. for developers willing to contribute to the BitBake documentation can
  18. be found in the Yocto Project Documentation README file:
  19. https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README
  20. How to build the Yocto Project documentation
  21. ============================================
  22. Sphinx is written in Python. While it might work with Python2, for
  23. obvious reasons, we will only support building the BitBake
  24. documentation with Python3.
  25. Sphinx might be available in your Linux distro packages repositories,
  26. however it is not recommend using distro packages, as they might be
  27. old versions, especially if you are using an LTS version of your
  28. distro. The recommended method to install Sphinx and all required
  29. dependencies is to use the Python Package Index (pip).
  30. To install all required packages run:
  31. $ pip3 install sphinx sphinx_rtd_theme pyyaml
  32. To build the documentation locally, run:
  33. $ cd doc
  34. $ make html
  35. The resulting HTML index page will be _build/html/index.html, and you
  36. can browse your own copy of the locally generated documentation with
  37. your browser.