summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* sphinx: ref-manual links fixes and many other cleanups to importRichard Purdie2020-09-1716-3439/+4886
| | | | | | (From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: remove leading '/'Nicolas Dechesne2020-09-171-3/+3
| | | | | | | | | | | When switching back and forth between between regular and mega manual an extra '/' keeps being added to the URL. Reported-by: Quentin Schulz <quentin.schulz@streamunlimited.com> (From yocto-docs rev: 4cb64afb2ab544d3f6433adc64824414838648ac) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-system-requirements: Improve formatting of the notes sections, ↵Richard Purdie2020-09-171-37/+35
| | | | | | | | merging them (From yocto-docs rev: 0b3360556bdce2a995b9931359f41cd4f6225aef) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: convert bsp-guideNicolas Dechesne2020-09-171-497/+571
| | | | | | | | | | 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>
* sphinx: index.rst: Fix linksRichard Purdie2020-09-171-2/+2
| | | | | | | | Correct the bitbake and megamanual URLs. (From yocto-docs rev: 9da83688584f891d9a1fa363bbf073ab7ba0aad7) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: Makefile.sphinx improvementsNicolas Dechesne2020-09-171-6/+10
| | | | | | | | | | | * 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>
* sphinx: brief-yoctoprojectqs: fix up all remaining rendering issuesNicolas Dechesne2020-09-171-151/+212
| | | | | | | | | Manual fix up for links, references, code-block, formatting issues.. (From yocto-docs rev: b0c5333c0f9321cdc1f46e1637cd5e9faf6b42a2) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual: fix heading for oe-init-build-envNicolas Dechesne2020-09-171-2/+2
| | | | | | | | | | | | | 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>
* sphinx: convert 'transitioning to a custom environment'Nicolas Dechesne2020-09-172-1/+117
| | | | | | | | | | | 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>
* sphinx: convert 'what I wish I'd known'Nicolas Dechesne2020-09-173-1/+232
| | | | | | | | | | | 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>
* sphinx: conf: include CSS/JS files, the proper wayNicolas Dechesne2020-09-172-5/+4
| | | | | | | | | | | 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>
* sphinx: makefile: add publish targetNicolas Dechesne2020-09-171-1/+8
| | | | | | | | | | 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>
* sphinx: conf: a few rendering tweaksNicolas Dechesne2020-09-171-0/+12
| | | | | | | | | | | * 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>
* sphinx: fix up terms related to kernel-fitimageNicolas Dechesne2020-09-171-14/+26
| | | | | | | | | | | | 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>
* sphinx: Add support for multiple docs versionRichard Purdie2020-09-175-6/+270
| | | | | | | | | | | | 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>
* sphinx: insert blank below between title and tocNicolas Dechesne2020-09-1711-0/+22
| | | | | | | | | | 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>
* sphinx: enable intersphinx extensionNicolas Dechesne2020-09-171-0/+6
| | | | | | | | | | | 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>
* sphinx: manuals: Move boilerplate after toctreeRichard Purdie2020-09-1710-18/+20
| | | | | | | | | 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>
* sphinx: history: Move revision history to its own sectionRichard Purdie2020-09-1718-415/+469
| | | | | | | | | 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>
* sphinx: boilerplate.rst: Sphinx puts the copyright elsewhereRichard Purdie2020-09-171-4/+3
| | | | | | | | Its elsewhere so drop from boilerplate. (From yocto-docs rev: b974d1193480e6b005e3e66ab809afdda6a89897) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: boilerplate.rst: Drop versions notes as we have better navigation nowRichard Purdie2020-09-171-21/+4
| | | | | | | | | | 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>
* sphinx: releases.rst: Add index/links to docs for previous releasesRichard Purdie2020-09-172-0/+189
| | | | | | | | (From yocto-docs rev: 627f06d19909eff246b08e889068fd1ecddd569b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: setup extlink for docs.yoctoproject.orgNicolas Dechesne2020-09-171-0/+1
| | | | | | | (From yocto-docs rev: ec5c86368b90e4fb92295780fb10cf29c66c0fb4) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add links to section in the Bitbake manualNicolas Dechesne2020-09-1714-71/+67
| | | | | | | | | | 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>
* sphinx: add links to terms in the BitBake glossaryNicolas Dechesne2020-09-174-10/+10
| | | | | | | | | | | | | | | | | 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>
* sphinx: fix links when the link text should be displayedNicolas Dechesne2020-09-1722-70/+70
| | | | | | | | | | | | | | | | | 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>
* sphinx: add links for Yocto project websiteNicolas Dechesne2020-09-1727-154/+140
| | | | | | | | | | | | | | 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>
* sphinx: Organize top level docsRichard Purdie2020-09-171-11/+36
| | | | | | | | | | 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>
* sphinx: toaster-manual: add figuresNicolas Dechesne2020-09-172-0/+34
| | | | | | | (From yocto-docs rev: 3b976f4b9a4fdcd8116b557a09fd18b69b684582) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: test-manual: add figuresNicolas Dechesne2020-09-171-0/+3
| | | | | | | (From yocto-docs rev: 35f1f1e06f79fd28889f188095156890aa898e17) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: sdk-manual: add figuresNicolas Dechesne2020-09-174-2/+29
| | | | | | | (From yocto-docs rev: 33f46470d53790ae986294e1776c5ca23f764976) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual: add figuresNicolas Dechesne2020-09-171-0/+4
| | | | | | | (From yocto-docs rev: 22a371230ab38df0558400a85829fb1e508b6e1d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix up bold text for informalexample containerNicolas Dechesne2020-09-171-10/+10
| | | | | | | | | | | | 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>
* sphinx: profile-manual: add figuresNicolas Dechesne2020-09-171-0/+66
| | | | | | | (From yocto-docs rev: bfa1c146265d165ddfa1a70488d0f043ec9df2ee) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: kernel-dev: add figuresNicolas Dechesne2020-09-172-0/+9
| | | | | | | (From yocto-docs rev: cd859cca2e6861fbb5bac68c2f6e972285c47dcb) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: dev-manual add figuresNicolas Dechesne2020-09-171-0/+18
| | | | | | | (From yocto-docs rev: 590ddc11263f00d912d874377199574c123c75b1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: manual updates for some linksNicolas Dechesne2020-09-1734-348/+327
| | | | | | | | | | | 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>
* sphinx: fix custom term linksNicolas Dechesne2020-09-176-18/+18
| | | | | | | | | | 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>
* sphinx: ref-manual: fix typoNicolas Dechesne2020-09-171-2/+2
| | | | | | | | | | 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>
* sphinx: fix internal linksNicolas Dechesne2020-09-1742-2221/+2221
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* sphinx: ref-manual: use builtin glossary for the Terms sectionNicolas Dechesne2020-09-172-1126/+1152
| | | | | | | | | | | | | | | 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>
* sphinx: conf.py: enable sphinx.ext.autosectionlabelNicolas Dechesne2020-09-171-0/+2
| | | | | | | | | | 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>
* sphinx: add a general indexNicolas Dechesne2020-09-172-0/+4
| | | | | | | | | | | | | | | This index is automatically generated by Sphinx, and all terms from the glossary are listed. It seems very convenient for the Yocto Project documentation. The implementation with an 'almost' empty file is tricky. It was borrowed from: https://stackoverflow.com/questions/40556423/how-can-i-link-the-generated-index-page-in-readthedocs-navigation-bar (From yocto-docs rev: 8af595c464b58cf46df7ef067832db5c841e9202) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual: add revision history tableNicolas Dechesne2020-09-179-0/+414
| | | | | | | (From yocto-docs rev: 36d1073119081b9c364f48aedf4086881bef03d6) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add boilerplate to manualsNicolas Dechesne2020-09-179-0/+18
| | | | | | | (From yocto-docs rev: d552acdc60c8a0467b649b95183b87b3345a4f8c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add boilerplate fileNicolas Dechesne2020-09-172-1/+35
| | | | | | | | | | | | A certain amount of boilerplate is added at the beginning of all documents. In DocBook this is copy/pasted in each file. Let's create a boilerplate ReST file, which we will include in each document, wherever it's required. (From yocto-docs rev: 37e0d5f246c614e62a7c0d4d72a5d6ce9ec5325e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: conf: add substitutions/global variablesNicolas Dechesne2020-09-173-0/+152
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Yocto Project documentation makes heavy use of 'global' variables. In Docbook these 'variables' are stored in the file poky.ent. This Docbook feature is not handled automatically with Pandoc. Sphinx has builtin support for substitutions however they are local to each reST file by default. They can be made global by using rst_prolog: rst_prolog A string of reStructuredText that will be included at the beginning of every source file that is read. However Sphinx substitution feature has several important limitations. For example, substitution does not work in code-block section. yocto-vars.py is an extension that processes .rst file to find and replace 'variables'. This plugin will do variables substitutions whenever a rst file is read, so it happens before sphinx parses the content. All variables are set in poky.yaml. It's a simple YAML file with pairs of variable/value, and the file is parsed once during setup. It's important to note that variables can reference other variables. poky.yaml was generated by converting poky.ent into a YAML format. To use a variable in the Yocto Project .rst files, make sure it is defined in poky.yaml, and then you can use : &DISTRO_NAME; For external links, Sphinx has a specific extension called extlinks, let's use it instead of variable substituions. Note that we intentionnally did not put the trailing '/' in the URL, this is to allow us to use :yocto_git:`/` trick to get the actual URL displayed in the HTML. (From yocto-docs rev: dc5f53fae8fdfdda04285869dd1419107b920bfe) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: conf: update copyrightNicolas Dechesne2020-09-171-2/+2
| | | | | | | (From yocto-docs rev: 9a5c74f73f2f00d8dbd3bc4f72973f9e2913b316) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add Yocto project logoNicolas Dechesne2020-09-172-0/+2
| | | | | | | (From yocto-docs rev: 125c70b04a28bf095ed1cd8273ebdc7d1d0b5cfd) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: bsp-guide: add figuresNicolas Dechesne2020-09-171-0/+3
| | | | | | | (From yocto-docs rev: 5341150c11270633fdb1428a59a3b7bd72123e7f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 10:14:31 +0000