Quentin Schulz d52190ea42 docs: static: theme_overrides.css: fix responsive design on <640px screens 3 éve
..
_templates cb19159cf8 sphinx: Enhance the sphinx experience/nagivation with: 3 éve
bitbake-user-manual c87cc35a56 docs: sphinx: replace special quotes with double quotes 3 éve
sphinx-static d52190ea42 docs: static: theme_overrides.css: fix responsive design on <640px screens 3 éve
template 01692654cd templates: Added newline character to end of script. 10 éve
tools d419907869 user-manual: Import YP Docs templates for usermanual improvements 10 éve
.gitignore 84ccba0f4a sphinx: add initial build infrastructure 3 éve
COPYING.GPL 31a11a03bc Update the GPL to the current version of the FSF 17 éve
COPYING.MIT d91e57c44e Initial import. 19 éve
Makefile e19320b4c4 Makefile: Updated the script to not create PDF version by default 9 éve
Makefile.sphinx 9ae5cce766 docs: sphinx: report errors when dependencies are not met 3 éve
README ec4c481a0c docs: update README file after migrationg to Sphinx 3 éve
bitbake.1 814c2b232e doc: Replace depexp UI with taskexp and cleanup UI lists 7 éve
conf.py 9ae5cce766 docs: sphinx: report errors when dependencies are not met 3 éve
genindex.rst 84ccba0f4a sphinx: add initial build infrastructure 3 éve
index.rst 63adcaa527 sphinx: add releases page 3 éve
poky.ent 3aaf8d6569 poky.ent: Removed "ECLIPSE" entity variables. 5 éve
releases.rst 63adcaa527 sphinx: add releases page 3 éve

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 -f Makefile.sphinx 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.