summaryrefslogtreecommitdiff
path: root/poky/bitbake/doc/README
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2020-11-03 03:44:49 +0300
committerAndrew Geissler <geissonator@yahoo.com>2020-11-03 23:32:06 +0300
commit4873add6e11c1bd421c83cd08df589f1184aa673 (patch)
treeaec4845be29329cca2a0b2d7c8f94249e48ed067 /poky/bitbake/doc/README
parent56a8292be03a7cb27f3b3ad762f4779e7e5ff47d (diff)
downloadopenbmc-4873add6e11c1bd421c83cd08df589f1184aa673.tar.xz
Revert "poky: subtree update:b23aa6b753..ad30a6d470"
This reverts commit af5e4ef732faedf66c6dc1756432e9de2ac72988. This commit introduced openbmc/openbmc#3720 and no solution has been forthcoming. Revert until we can get to the bottom of this. Change-Id: I2fb0d81eb26cf3dadb2f2abdd1a1bb7a95eaf03c
Diffstat (limited to 'poky/bitbake/doc/README')
-rw-r--r--poky/bitbake/doc/README50
1 files changed, 17 insertions, 33 deletions
diff --git a/poky/bitbake/doc/README b/poky/bitbake/doc/README
index 62595820bd..303cf8eec7 100644
--- a/poky/bitbake/doc/README
+++ b/poky/bitbake/doc/README
@@ -15,41 +15,25 @@ 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
-======
+Makefile
+========
-The BitBake documentation was migrated from the original DocBook
-format to Sphinx based documentation for the Yocto Project 3.2
-release.
+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.
-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:
+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:
-https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README
+ $ make DOC=bitbake-user-manual
-How to build the Yocto Project documentation
-============================================
+template
+========
+Contains various templates, fonts, and some old PNG files.
-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.
+tools
+=====
+Contains a tool to convert the DocBook files to PDF format.