Now that the DocBook files are removed, we can rename the top level
Makefile.
(From yocto-docs rev: 25fefa9a91ba5d7b398443f543e2c46165e8a3f4)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Before the move to Sphinx, it used to be possible to get a direct link to a
variable from the term glossary. It is very useful when pointing people to
a specific variable when manually looking for it in the glossary.
Let's add this "feature" back.
(From yocto-docs rev: 9e468274eaad270efd5f50e58a523798fcb8097e)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since the move to sphinx, variables aren't linked with var- anchors but
term-.
Let's fix that so clicking on a letter will bring to the correct variable
in the page.
(From yocto-docs rev: 07718faa04a8b121be004afbc23b4c338f669413)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The following changes were required after a review of trademark and
branding guidelines:
1. add (R) to 'Yocto Project' on the top left (above the logo)
2. Fix up the capitalization of the main page title
3. Add the copyright/legal blurb at the bottom of the page
For 3. it turned out to be simpler to override the whole footer.html
template, and maintain our own version. Also I took the liberty to
remove the 'next' and 'previous' buttons since I believe they are not
especially useful, given the navigation bar on the left side.
Reported-by: Tracey Erway <tracey.m.erway@intel.com>
(From yocto-docs rev: 6bae1372218e0b10258e4fa6fef72fc1708a329c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This documents the variables used to create keys for
signing fitImage.
(From yocto-docs rev: 7d0407249907259b59191e3759a3b140d30d993e)
Signed-off-by: Usama Arif <usama.arif@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
IMAGE_EFI_BOOT_FILES created to help differentiate files needed between
bootimg-efi and bootimg-partition when creating the installer/.wic file.
(From yocto-docs rev: 3430e56aaa8a528a062af534610dc60346347947)
Signed-off-by: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updated the README to include instructions to build the doc with
sphinx
* Added design guidelines for new contributors
(From yocto-docs rev: 7f64574f7594de22fbd29d9da9b8c9df4ba05ffb)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To build the Sphinx documentation, we have the following dependencies:
* sphinx
* sphinx_rtd_theme
* pyyaml
If any of these dependencies are missing, we might end up with some
cryptic error messages. This patch adds better error reporting when
dependencies are not met.
(From yocto-docs rev: 19df8d1ec56dc2ecb44122288cc53e84237fab69)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
From experience the body takes the whole space anyway and the text stays
within the screen boundaries by default, no need to make the min-width
640px then.
(From yocto-docs rev: 69f57cd708bafd99c4a35c7929d70ae047bfe0d8)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In order to be able to build this example from anywhere, one needs
to give the relative path from LAYERDIR to the .inc file.
The path is the one for the inc file from openembedded-core.
(From yocto-docs rev: cb92d16a6d638f39effa06a7334496f1b0c83b2a)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The 2.3 example was not working anymore so fixed it and upgraded all
at once.
(From yocto-docs rev: 12457c2410c4f0bfda254ceb4f5ef35127a7540f)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Does not seem to be formatted correctly by Sphinx (escaped `).
(From yocto-docs rev: 8363dcea98a12a6b8438a284bcebce35b269eab6)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The release selection for the documentation is fortunately not so complex anymore.
Let's also add a link to the mega-manual instead of just naming it and mention the
search bar as well.
(From yocto-docs rev: 6e46e41a965d2360a41a43263b2c100c5f77541e)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clarifies that virtual providers are only used for build time
dependencies specified with PROVIDES and DEPENDS, and do not apply to
runtime dependencies specified with RPROVIDES and RDEPENDS.
(From yocto-docs rev: dbca49573ce5c5c006c97f79d1107eafee83dc10)
Signed-off-by: Joshua Watt <Joshua.Watt@garmin.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This avoids the duplicate heading warnings at the slight expense
of more directory clutter.
(From yocto-docs rev: ef896d71836aa3bd6c926b36976a9c45d5f2ca15)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This more closely matches the original docbook style and is appropriate
given the way the manual uses this element.
(From yocto-docs rev: d49ea9831dc7deccde34c63158afc114d8721857)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The ADT Manual is deprecated, and was removed from the documentation
set in 2.2, until we remove it completely, let's make sure it's
excluded from Sphinx build.
(From yocto-docs rev: 5fa20d6afb1be56cbb2a012357f8ccff4b91d585)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It is used in the Profile manual. Let's make it look like other note,
warning, .. admonition.
(From yocto-docs rev: 9aa4a7e8def8793c58a8fda1fdd661dcfffad785)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The 'verbatim' text was rendered with Courier font in DocBook
(e.g. when using the <filename> tag). With DocBook we are using the
``FOO`` notation which ends up in a <pre> class in the HTML
output. Configure the theme CSS to use Courier, to preserve the look
and feel of the original docs.
(From yocto-docs rev: ecd748fb212abe64af1edbe4c44130425faf5688)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Last round of manual fixes for remaining links and conversion problems
left after the automatic conversion.
(From yocto-docs rev: 071bca4573bc8c60aef1d89896d6536867fe46e5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The initial theme override covers for tip and and note only.
(From yocto-docs rev: 69b1414b42701599d5c0d62f637cd0cddf80b25e)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Last round of manual fixes for remaining links and conversion
problems.
(From yocto-docs rev: 954801327bf2574e6d7bc9275985be17cfd086f1)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Correct the bitbake and megamanual URLs.
(From yocto-docs rev: 9da83688584f891d9a1fa363bbf073ab7ba0aad7)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* add 'clean' target
* use DESTDIR to set the final folder when publishing. e.g.
make -f Makefile.sphinx publish DESTDIR=yp-docs
(From yocto-docs rev: 35c0076bf668a81391ee99316241d180528123fc)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
