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>
This extension can generate automatic links to the documentation of
objects in other projects. We will use it to use cross references with
the Bibtake manual, for example.
(From yocto-docs rev: 5add9854b112f93acba982f237fbfa83aee80d77)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The boilerplate looks better after the ToC, still not quite
right but the boilerplate can be improved from here.
(From yocto-docs rev: 5e81b9c90f6f45acf26ba146e280bc2659ac14e5)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The revision history tables look better in their own section,
move them.
(From yocto-docs rev: 27bf0f69b6dc04cea97a023ef52bec2b213d074f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Its elsewhere so drop from boilerplate.
(From yocto-docs rev: b974d1193480e6b005e3e66ab809afdda6a89897)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now we have better navigation with sphinx, and alert text about old
versions, we can drop the top two bullts. The remaining bits can just
become text.
(From yocto-docs rev: bb963c8c906644148182a1fc441c676f13cdf6ce)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use intersphinx extension to replace links to the Bitbake manual with
proper cross references.
(From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using the intersphinx extension, we can refer to terms in the Bitbake
manual using :term:`bitbake:FOO`. This patch implements that, mostly
using the following regexp:
line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_BB_URL;)?#var(-bb)?-\\1>`__",
":term:`bitbake:\\1`",
line)
And a handful of manual fixup.
(From yocto-docs rev: d2ed9117fffceb756c4a8f3cb6d39363a271d6d9)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When an hyperlink should be display in the output, there is no need to
any specific syntax or marker, the parser finds links and mail
addresses in ordinary text. Somehow the conversion from pandoc
generated wrong output in the form: ` <link>`__. This patch is
generated using the following Python regexp:
line = re.sub("` <(https?://.*)>`__",
"\\1",
line)
(From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..
In Sphinx they are replaced with extlinks.
(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clean up the top level docs index to refer to all the manuals
with decent titles/links/layout and match the current website docs
page links.
(From yocto-docs rev: 45138057bf9446dfca7bf1ddef97104df57abe76)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With DocBook the 'informalcontainer' include a 'title' which was
rendered as bold with CSS. However when using the Sphinx container
directive to create a custom container, it's just content without
title, so make the title bold.
(From yocto-docs rev: 8947e6b71baa6c9bf06751018bc2b98f8be1b6fd)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some links were not found by the regexp, especially because of they
are spanning across multiple lines. This patch is a manual fixup for
these patterns.
(From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some term links have custom 'text', and require manual update, since
they were not caught by the generic Python regexp.
(From yocto-docs rev: 519355ba9daf7630e8d477b2f6f511be51fd8b2e)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The variable name is SSTATE_MIRROR, not STATE_MIRROR, and because of
the typo, it was not caught by the Python regexp.
(From yocto-docs rev: 7347f5343c4995c53da6b9a88a3912453def9669)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Many of the internal links were not converted probably from DocBook
using pandoc. After looking at the various patterns, the follow series
of 'naive' Python regexp were used to perform some additional
automatic conversion.
Also, since we rely on built-in glossary, all links to terms need to
use the sphinx :term: syntax.
This commit is generated using the following Python series of regexp:
line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__",
":term:`\\1`",
line)
line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__",
":ref:`ref-tasks-\\1`",
line)
line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1.bbclass <ref-classes-\\1>`",
line)
line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1 <ref-classes-\\1>`",
line)
line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__",
":term:`Source Directory`",
line)
line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__",
":term:`Build Directory`",
line)
line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__",
":term:`Metadata`",
line)
line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__",
":term:`BitBake`",
line)
line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__",
":ref:`ref-manual/ref-images:Images`",
line)
line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__",
":ref:`ref-manual/ref-classes:Classes`",
line)
line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__",
":ref:`devtool-the-workspace-layer-structure`",
line)
line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__",
":term:`OpenEmbedded Build System`",
line)
line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__",
":term:`OpenEmbedded-Core (OE-Core)`",
line)
It won't catch multiline strings, but it catches a very large number
of occurences!
(From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using the builting glossary is well suited for the Yocto Project
'terms' section. Conveniently, all terms will also be added in the
global index.
While converting this to a glossary, also fixed up some content which
was not properly converted by pandoc (such as codeblock sections, or
references in between terms).
(From yocto-docs rev: fce1d16eac1a92f3c6b7bfc74600197b5cb668a2)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This extension generates the labels for each section, so that we can
reference section by their title.
(From yocto-docs rev: 910bdad33819116f00fd4f849dcf7484fbebb465)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
