Nicolas Dechesne 2908137565 bitbake-user-manual: fix bad links 3 years ago
..
_templates cb19159cf8 sphinx: Enhance the sphinx experience/nagivation with: 3 years ago
bitbake-user-manual 2908137565 bitbake-user-manual: fix bad links 3 years ago
sphinx-static a0f3778949 sphinx: theme_override: Use bold for emphasis text 3 years ago
template 01692654cd templates: Added newline character to end of script. 10 years ago
tools d419907869 user-manual: Import YP Docs templates for usermanual improvements 10 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 e19320b4c4 Makefile: Updated the script to not create PDF version by default 9 years ago
Makefile.sphinx 219b2348f5 sphinx: Makefile.sphinx: add clean and publish targets 3 years ago
README 452a62ae0c doc: Rename user-manual -> bitbake-user-manual 10 years ago
bitbake.1 814c2b232e doc: Replace depexp UI with taskexp and cleanup UI lists 7 years ago
conf.py 3e940d93c7 sphinx: conf: enable extlinks extension 3 years ago
genindex.rst 84ccba0f4a sphinx: add initial build infrastructure 3 years ago
index.rst 63adcaa527 sphinx: add releases page 3 years ago
poky.ent 3aaf8d6569 poky.ent: Removed "ECLIPSE" entity variables. 5 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.

Makefile
========

The Makefile processes manual directories to create HTML, PDF,
tarballs, etc. Details on how the Makefile work are documented
inside the Makefile. See that file for more information.

To build a manual, you run the make command and pass it the name
of the folder containing the manual's contents.
For example, the following command run from the documentation directory
creates an HTML and a PDF version of the BitBake User Manual.
The DOC variable specifies the manual you are making:

$ make DOC=bitbake-user-manual

template
========
Contains various templates, fonts, and some old PNG files.

tools
=====
Contains a tool to convert the DocBook files to PDF format.