Nicolas Dechesne a7c47f1eac sphinx: rename Makefile.sphinx 3 years ago
..
_templates cb19159cf8 sphinx: Enhance the sphinx experience/nagivation with: 3 years ago
bitbake-user-manual 427721d8ff sphinx: remove DocBook files 3 years ago
sphinx-static d52190ea42 docs: static: theme_overrides.css: fix responsive design on <640px screens 3 years ago
template 427721d8ff sphinx: remove DocBook files 3 years ago
.gitignore 84ccba0f4a sphinx: add initial build infrastructure 3 years ago
COPYING.GPL 31a11a03bc Update the GPL to the current version of the FSF 17 years ago
COPYING.MIT d91e57c44e Initial import. 19 years ago
Makefile a7c47f1eac sphinx: rename Makefile.sphinx 3 years ago
README a7c47f1eac sphinx: rename Makefile.sphinx 3 years ago
bitbake.1 814c2b232e doc: Replace depexp UI with taskexp and cleanup UI lists 7 years ago
conf.py 9ae5cce766 docs: sphinx: report errors when dependencies are not met 3 years ago
genindex.rst 84ccba0f4a sphinx: add initial build infrastructure 3 years ago
index.rst 63adcaa527 sphinx: add releases page 3 years ago
releases.rst 63adcaa527 sphinx: add releases page 3 years ago

README

Documentation
=============

This is the directory that contains the BitBake documentation.

Manual Organization
===================

Folders exist for individual manuals as follows:

* bitbake-user-manual - The BitBake User Manual

Each folder is self-contained regarding content and figures.

If you want to find HTML versions of the BitBake manuals on the web,
go to http://www.openembedded.org/wiki/Documentation.

Sphinx
======

The BitBake documentation was migrated from the original DocBook
format to Sphinx based documentation for the Yocto Project 3.2
release.

Additional information related to the Sphinx migration, and guidelines
for developers willing to contribute to the BitBake documentation can
be found in the Yocto Project Documentation README file:

https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README

How to build the Yocto Project documentation
============================================

Sphinx is written in Python. While it might work with Python2, for
obvious reasons, we will only support building the BitBake
documentation with Python3.

Sphinx might be available in your Linux distro packages repositories,
however it is not recommend using distro packages, as they might be
old versions, especially if you are using an LTS version of your
distro. The recommended method to install Sphinx and all required
dependencies is to use the Python Package Index (pip).

To install all required packages run:

$ pip3 install sphinx sphinx_rtd_theme pyyaml

To build the documentation locally, run:

$ cd documentation
$ make html

The resulting HTML index page will be _build/html/index.html, and you
can browse your own copy of the locally generated documentation with
your browser.