summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UKRichard Purdie2020-10-0881-81/+81
| | | | | | | | | | | When the license identifier tags were added, an incorrect string was used and the Share-Alike clause was lost. Fix this to match the license description in the files and add back the lost piece (its clear from the history it should be there) (From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: rename Makefile.sphinxNicolas Dechesne2020-10-062-4/+4
| | | | | | | | | | 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>
* sphinx: remove DocBook filesNicolas Dechesne2020-10-06208-100194/+0
| | | | | | | | | | 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>
* docs: ref-manual: ref-variables: add links to terms in glossaryQuentin Schulz2020-10-031-587/+587
| | | | | | | | | | | | | | 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>
* docs: ref-manual: ref-variables: fix alphabetical order in glossaryQuentin Schulz2020-10-031-85/+85
| | | | | | | | (From yocto-docs rev: 77aa3990cab4fb01706d0b6b0284c38e4d9dda56) 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>
* docs: ref-manual: ref-variables: fix one-letter pointer links in glossaryQuentin Schulz2020-10-031-8/+8
| | | | | | | | | | | | | 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>
* sphinx: fix up some trademark and branding issuesNicolas Dechesne2020-10-013-3/+15
| | | | | | | | | | | | | | | | | | | | 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>
* ref-manual: document authentication key variablesUsama Arif2020-10-012-1/+26
| | | | | | | | | | 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>
* sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILESKhairul Rohaizzat Jamaluddin2020-09-291-1/+37
| | | | | | | | | | 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>
* README: include detailed information about sphinxNicolas Dechesne2020-09-291-28/+255
| | | | | | | | | | | * 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>
* sphinx: report errors when dependencies are not metNicolas Dechesne2020-09-223-5/+24
| | | | | | | | | | | | | | | | 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>
* docs: fix broken linksQuentin Schulz2020-09-2214-29/+30
| | | | | | | | (From yocto-docs rev: 5139bf1d3ac7f31b711a8410a195ffc88ac560bf) 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>
* docs: static: theme_overrides.css: fix responsive design on <640px screensQuentin Schulz2020-09-221-2/+0
| | | | | | | | | | | | 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>
* ref-manual: examples: libxpm: add relative path to .incQuentin Schulz2020-09-171-1/+1
| | | | | | | | | | | | | 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>
* ref-manual: examples: hello-autotools: upgrade to 2.10Quentin Schulz2020-09-172-8/+9
| | | | | | | | | | | 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>
* sphinx: fix or add missing links and remove mention of Eclipse workflowQuentin Schulz2020-09-173-35/+31
| | | | | | | | | | The Eclipse plugin has long been gone. (From yocto-docs rev: f7a01e67d760c1de3f5a36e3513cba1627b4ed96) 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>
* sphinx: "highlight" some variables, tasks or filesQuentin Schulz2020-09-173-66/+35
| | | | | | | | (From yocto-docs rev: 41e379dc32e52cec652a7f89caf4c3fd96dd2dda) 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>
* sphinx: fix a few typos or missing/too many wordsQuentin Schulz2020-09-175-18/+16
| | | | | | | | (From yocto-docs rev: 744b74b3420ae475a566307e03e0b098986773e4) 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>
* sphinx: brief-yoctoprojectqs: put other distros note after Ubuntu-specific ↵Quentin Schulz2020-09-171-4/+4
| | | | | | | | | | packages (From yocto-docs rev: 529de3ad21122970c02b86da99d6cc96b58c3333) 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>
* sphinx: fix incorrect indentationsQuentin Schulz2020-09-173-13/+11
| | | | | | | | (From yocto-docs rev: af5209df6c8c1dcc852d29b72968aa0b36b6b761) 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>
* sphinx: replace special quotes with single and double quotesQuentin Schulz2020-09-1726-106/+106
| | | | | | | | (From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675) 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>
* sphinx: overview-manual: remove highlight in bold sectionQuentin Schulz2020-09-171-1/+1
| | | | | | | | | | 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>
* sphinx: what-i-wish-id-known: update "don't be fooled by doc search results"Quentin Schulz2020-09-171-15/+11
| | | | | | | | | | | | | 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>
* sphinx: brief-yoctoprojectqs: add note on branch consistency between layersQuentin Schulz2020-09-171-0/+6
| | | | | | | | (From yocto-docs rev: c00d387068e914290efdc9c5e7fcef5b38ce6e86) 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>
* sphinx: overview-manual: fix bitbake basic explanationQuentin Schulz2020-09-171-2/+2
| | | | | | | | | | One requests Bitbake to bake a recipe to create packages. (From yocto-docs rev: 2b9a0131999d0d0c014968f792348c55afca4c2c) 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>
* sphinx: overview-manual: add link to AUH how-to sectionQuentin Schulz2020-09-171-1/+3
| | | | | | | | (From yocto-docs rev: cd46ce1cf6b5f5de2e0751c582e92a9417308441) 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>
* sphinx: brief-yoctoprojectqs: add missing boilerplateQuentin Schulz2020-09-171-0/+2
| | | | | | | | (From yocto-docs rev: 4a34fdbeda4e3ad5ae63d159417b7cf204205847) 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>
* sphinx: brief-yoctoprojectqs: fix ambiguous note for cyclone5 exampleQuentin Schulz2020-09-171-1/+1
| | | | | | | | (From yocto-docs rev: a9ea4642f49bf4ddaef07fbc2e1612511a2db9f4) 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>
* sphinx: brief-yoctoprojectqs: remove redundant welcomeQuentin Schulz2020-09-171-1/+1
| | | | | | | | (From yocto-docs rev: e582e82f37905cdcb02ed9189b2ebffd689f0418) 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>
* sphinx: toaster-manual: fix vars, links, code blocksTim Orling2020-09-174-287/+567
| | | | | | | | | | | Also update Django links to 2.2 LTS release (from 1.11) Replace most references to 'rocko' with variable (From yocto-docs rev: ddf1e119db93fc3f8b141a04f6d0009f933b1006) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: dev-manual: Clarify that virtual providers do not apply to runtime ↵Joshua Watt2020-09-171-0/+6
| | | | | | | | | | | | | | dependencies 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>
* sphinx: test-manual code block, link, and format updateMark Morton2020-09-173-184/+257
| | | | | | | | (From yocto-docs rev: 928c212ec4ad6e09524fdf8147aa7daf244677b0) Signed-off-by: Mark Morton <mark.morton@windriver.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: overview-manual: Various URL, code block and other fixes to imported ↵Richard Purdie2020-09-174-236/+270
| | | | | | | | data (From yocto-docs rev: 3325fe660dfea24fba2f964a0060664e3c67459a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: ref-manual/migration: Split each release into its own fileRichard Purdie2020-09-1718-5234/+5271
| | | | | | | | | 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>
* sphinx: ref-tasks: Add populate_sdk_ext task definitionRichard Purdie2020-09-171-0/+11
| | | | | | (From yocto-docs rev: 0d4cc867c3faa0144ed5a2aaa2698a6f693a2404) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: theme_override: Use bold for emphasis textRichard Purdie2020-09-171-0/+4
| | | | | | | | | 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>
* sphinx: conf: exclude adt-manual/*.rstNicolas Dechesne2020-09-171-1/+2
| | | | | | | | | | | 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>
* sphinx: theme_override: add tying-it-together admonitionNicolas Dechesne2020-09-171-0/+2
| | | | | | | | | | 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>
* sphinx: theme_override: properly set font for verbatim textNicolas Dechesne2020-09-171-0/+5
| | | | | | | | | | | | | 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>
* sphinx: profile-manual: convert profile-manualNicolas Dechesne2020-09-174-1108/+1657
| | | | | | | | | | 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>
* sphinx: update style for important, caution and warningsNicolas Dechesne2020-09-171-2/+11
| | | | | | | | | 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>
* sphinx: kernel-dev: Various URL, code block and other fixes to imported dataRichard Purdie2020-09-176-556/+1182
| | | | | | (From yocto-docs rev: 4888b49ccc5d133b4096e5a9b808f14d1afc7deb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: sdk-manual: Various URL, code block and other fixes to imported dataRichard Purdie2020-09-176-282/+623
| | | | | | (From yocto-docs rev: 12f5e9cb36409b813ffef9242ce9a042f08acf69) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: dev-manual: Various URL, code block and other fixes to imported dataRichard Purdie2020-09-174-1540/+3200
| | | | | | (From yocto-docs rev: 8e73d870e9dc2df416f5c5cf5b10ef552be0aa6d) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>