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>
In DocBook this section name is set to &OE_INIT_FILE;
variable. However using a substitution pattern in a heading in Sphinx
does not seem to work well. Let's just set the script environment name
here directly, without using a variable. We don't expect to change
this name anyways, so a variable is not really needed.
(From yocto-docs rev: e3347fa41888183c0818852fc07d1e0735406156)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This page is currently a static web page in the Yocto project website,
in the docs section. While we are converting the whole YP docs into
its own website, let's convert this file as well.
(From yocto-docs rev: 0985ac0570c63e5ac8c4329155ed77f71f56f069)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This page is currently a static web page in the Yocto project website,
in the docs section. While we are converting the whole YP docs into
its own website, let's convert this file as well.
(From yocto-docs rev: 1d4db1f776cdb775f79cd5e2089da01e0d9c43ea)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
html_css_files and html_js_files exist since Sphinx 1.8, and it's the
proper (documented) mechanism to include custom CSS and JS files in
the documentation.
(From yocto-docs rev: 4ae9c426654e33fed4185e5d6e0de76b4a430d84)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The 'publish' target prepares the sphinx output, so that it can be
transfered on the YP website.
(From yocto-docs rev: f7a06204ef94f9b71174de5364a62ba04deb709b)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove the 'generated by Sphinx' text on each page
* Add a 'last updated timestamp' on each page
* Remove the trailing 'dot' in TOC numbering
(From yocto-docs rev: 3fa6cf149b3dbbd88b3aa75b6ce1f8bd12817c91)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In this commit: 3aeca3b342e5 (ref-manual: Add documentation for
kernel-fitimage), we added a few terms in the glossary, in the docbook
xml file. However there were a few issues in the conversion to sphinx
which needed to be fixed (missed terms, typo, and wrong placement).
(From yocto-docs rev: 968efa8275e30350cead66613d01f491ee61be4d)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Enhance the sphinx experience/nagivation with:
* Remove the pointless looking parts of breadcrumb navigtation
* Add a document type switcher to the breadcrumb navigation
* Add a version selection switch to the breadcrumb navigation
(From yocto-docs rev: 1823624bdb9ea002d44c9e6d0fd4cd662bff36ad)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Whenever a TOC follows a title/heading, a blank line is missing. So
let's add it explicitely.
(From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
