summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* bitbake: doc: bitbake-user-manual: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-07-266-151/+151
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If a variable has a glossary entry and some rST files write about those variables, it's better to point to the glossary entry instead of just highlighting it by surrounding it with two tick quotes. The script that is used to do the replacement of ``FOO`` by :term:`FOO` is the following Python code: import re from pathlib import Path from runpy import run_module import contextlib import io import sys re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)') terms = [] new_terms = set() with contextlib.redirect_stdout(io.StringIO()) as f: run_module('sphinx.ext.intersphinx', run_name='__main__') objects = f.getvalue() match = re_term.search(objects) while match: if match.group(1): terms.append(match.group(1)) match = re_term.search(objects, match.end()) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".join(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) This script takes one argument as input: an objects.inv which can be gotten from doc/_build/html/objetcs.inv after running `make html`. Note that this excludes from replacement terms that appear in section titles as it requires refs to be changed too. This can be automated too if need be but right now it looks a bit confusing to have an anchor link (for sections) also have a term/reference link in it. I am not sure this is desired today. (Bitbake rev: aba88f40c47133ed9bc999e0298aca3bc8490912) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: ref-variables: force glossary output to ↵Quentin Schulz2021-07-261-0/+1
| | | | | | | | | | | | | | | | | be alphabetically sorted Even though, care should be taken to have the terms in the glossary sources alphabetically ordered, it is possible some terms might be in the wrong place. This makes sure that whatever the order of terms in the glossary sources, the generated medium is correctly sorted. (Bitbake rev: 98809ebc6ad51f0a94cedccfaff9c11d3744dc0d) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: ref-variables: order alphabetically the ↵Quentin Schulz2021-07-261-27/+27
| | | | | | | | | | | | glossary sources This reorders a few entry so that they are alphabetically sorted. (Bitbake rev: 311350ed5cb164d975c2119e60255a409e27dffb) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Makefile: turn warnings into errors by defaultQuentin Schulz2021-07-261-1/+1
| | | | | | | | | | | | | | -W is for turning warnings into errors, --keep-going to make sure the whole documentation is built and all warnings will be printed before failing. Since there's currently no warning, it's time to introduce it! (Bitbake rev: 6b0b3d707f662ca7b1d0de99fe032e4f35867d10) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: fix erroneous statement in glossary introMichael Opdenacker2021-06-061-4/+0
| | | | | | | | | | | This is the BitBake glossary. Remove an erroneous statement probably coming from the introduction to the YP/OE glossary. (Bitbake rev: 398a1686176c695d103591089a36e25173f9fd6e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Add BB_HASHSERVE definition to glossaryMichael Opdenacker2021-06-061-0/+10
| | | | | | | (Bitbake rev: 0ab3255f8e9d9c8c8aa4788504ab06a50d1bb1f2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: user-manual: ref-manual: remove mentions to ↵Quentin Schulz2021-06-063-22/+0
| | | | | | | | | | | | | | | | | | | | | | BB_SETSCENE_VERIFY_FUNCTION2 This variable was removed in July 2019 with commit 5deaa5df730a "runqueue: Drop unused BB_SETSCENE_VERIFY_FUNCTION2". There's no replacement, so let's update the documentation to not mention this variable anymore. This was found by running: git grep -hoP '^ :term:`\K\w+(?=`)' doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | \ xargs -I{} sh -c \ "grep -Rq --include='*.py' --include='*.conf' --include='*.bbclass' --include='*.bb' --include='*.bbappend' --include='*.inc' \ -w -E {}'_*(_[a-z]+[0-9a-z]*[a-z]+)*' || \ echo {}" (Bitbake rev: c2c0f5126c7c784bfd7a08f127e161a58c6b5d12) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: user-manual: remove mentions to BBVERSIONSQuentin Schulz2021-06-062-42/+9
| | | | | | | | | | | | | | | | | | | | BBVERSIONS support was dropped in November 2016 in commit 0bb188f01e39 "ast: remove BBVERSIONS support". Let's update the documentation to reflect this. This was found by running: git grep -hoP '^ :term:`\K\w+(?=`)' doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | \ xargs -I{} sh -c \ "grep -Rq --include='*.py' --include='*.conf' --include='*.bbclass' --include='*.bb' --include='*.bbappend' --include='*.inc' \ -w -E {}'_*(_[a-z]+[0-9a-z]*[a-z]+)*' || \ echo {}" (Bitbake rev: 376e20c1aaff197020cdb68d309b3b22f19dafe8) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: fix typo left over from Sphinx migrationNicolas Dechesne2021-04-261-2/+2
| | | | | | | | | | Fixes d99760cc687c (sphinx: last manual round of fixes/improvements) Reported-by: Michal Piechowski <m.z.piechowski@gmail.com> (Bitbake rev: 00ce48919de720639eda2b6f7065a82b641e5167) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: code insertion simplification over two linesMichael Opdenacker2021-04-261-6/+3
| | | | | | | | | | | | | | | This simplifies paragraphs ending with a colon and followed by code insertion. Automatically substituted through the command: sed -i -z "s/:\n\s*::/::/g" file.rst This generates identical HTML output. (Bitbake rev: 51c80fc3497eecc8e50194fe1ff8069b59f03eda) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: simplify colon usageMichael Opdenacker2021-04-266-193/+193
| | | | | | | | | | - This replaces instances of ": ::" by "::", which generates identical HTML output (Bitbake rev: fd8ce4dcaff3aae395f9945fb0a3be54905e1727) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/user-manual-fetching: Remove basepath unpack parameter docsRichard Purdie2021-04-201-3/+0
| | | | | | | | | | | | The code for this was removed in 2016 in commit e659a3b0c2771679057ee3e13cd42e6c62383ff2. Nobody seems to have missed it so remove the documentation so we match the code. [YOCTO #13449] (Bitbake rev: 76bf42ea41a28b19d0377c2e548b0a59119fdf67) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: add REQUIRED_VERSION and adjust ↵Paul Eggleton2021-04-151-2/+16
| | | | | | | | | | | | PREFERRED_VERSION entry Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and adjust the opening statement to read slightly better. (Bitbake rev: b32e6c8d4ea2f83fe77021207e9db883fec82d97) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: document no support for using passwords in git ↵Paul Eggleton2021-04-151-0/+9
| | | | | | | | | | | | URLs This is based on the comment added in revision aded964eed4ce5a725ed1ab477efabc86b1aa481. (Bitbake rev: 082683da089115d8b6f71f221cabb41ac401f733) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: fix syntax error in layer.conf exampleRobert P. J. Day2021-03-221-1/+2
| | | | | | | | | | | While this example really needs to be rewritten to not define multiple patterns in the same layer.conf, as long as it's there, it might as well be syntactically correct. (Bitbake rev: 1c2d2875099a3ff9149710d42c679ab31b00f68b) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: fix glossary link for BB_INVALIDCONF variableRobert P. J. Day2021-03-221-1/+1
| | | | | | | (Bitbake rev: 4a4d55c41806815c32add32863a05351a6df30f7) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: mention that addtask handles multiple dependenciesRobert P. J. Day2021-03-221-0/+11
| | | | | | | | | | Add a note explaining that "addtask" can accept multiple dependencies, just in case someone runs across such an example and is confused. (Bitbake rev: 5e4e9acd323b5ebc3a14c07384f6cf8f8a272066) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: move BBFILES_DYNAMIC for alphabetical orderRobert P. J. Day2021-03-151-39/+39
| | | | | | | | | | Since BBFILES_DYNAMIC does not have a "BB_" prefix, it belongs further down in the variable glossary. (Bitbake rev: 493f291601c7680f8b8146f358c545fcb5f53cc9) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Add AZ_SAS definition to glossaryAlejandro Hernandez Samaniego2021-03-111-0/+13
| | | | | | | (Bitbake rev: 134df841b273d94e767426876459da348d96dd23) Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Add Az fetcher documentationAlejandro Hernandez Samaniego2021-03-112-0/+30
| | | | | | | (Bitbake rev: e3b480636a3c2716effd619b59cf55e11f9a6db0) Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-worker/runqueue: Add support for BB_DEFAULT_UMASKRichard Purdie2021-02-161-0/+4
| | | | | | | | | | | | | Currently each task has to have a umask specified individually. This is leading to determinism issues since it is easy to miss specifying this for an extra task. Add support for specifing the default task umask globally which simplifies the problem. (Bitbake rev: 3e664599fd54a8a37ce587022fcbce5ca26f2ed3) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Makefile: enable parallel buildNicolas Dechesne2020-11-241-1/+1
| | | | | | | | | | | | >From sphinx-build man page: -j N build in parallel with N processes where possible (special value "auto" will set N to cpu-count) (Bitbake rev: e0d08058d849cb28cd70ade0cb35863a91019353) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: Add missing documentation MakefileRichard Purdie2020-11-241-0/+35
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/conf.py: add missing import sysMert Kirpici2020-11-201-0/+1
| | | | | | | | | | | Due to the calls to sys.stderr.write() and sys.exit() in exception handling in case of sphinx_rtd_theme not being installed, the following exception is raised by Python due to the fact that sys module not being imported. (Bitbake rev: 5ddf0e5bee0de59d07295fc5693e20b1a0380fde) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: rename Makefile.sphinxNicolas Dechesne2020-10-061-35/+0
| | | | | | | | | Now that the DocBook files are removed, we can rename the top level Makefile. (Bitbake rev: a7c47f1eac8caac607a2b5f12d07235dff4d740f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* bitbake: sphinx: remove DocBook filesNicolas Dechesne2020-10-0625-11898/+0
| | | | | | | | | | The BitBake documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (Bitbake rev: 427721d8ff2c8e1db8cb490074f2eed88d03852a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: static: theme_overrides.css: fix responsive design on <640px ↵Quentin Schulz2020-10-061-2/+0
| | | | | | | | | | | | | | screens 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. (Bitbake rev: d52190ea426d961f609c657dcb403baf59352969) 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>
* bitbake: docs: sphinx: report errors when dependencies are not metNicolas Dechesne2020-10-062-1/+11
| | | | | | | (Bitbake rev: 9ae5cce76693d7c12396cee1183aaf371bb3d66c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: update README file after migrationg to SphinxNicolas Dechesne2020-10-061-17/+33
| | | | | | | (Bitbake rev: ec4c481a0c3a3ccd0ef0832f128afdc047876552) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: sphinx: replace special quotes with double quotesNicolas Dechesne2020-10-065-9/+9
| | | | | | | (Bitbake rev: c87cc35a5665afbf67f6dbb3458976c215fd5ee3) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: ref-variables: add links to terms in glossaryNicolas Dechesne2020-10-061-122/+122
| | | | | | | | | | This is similar to this change in yocto-docs: 9e468274eaad (docs: ref-manual: ref-variables: add links to terms in glossary) (Bitbake rev: ebdeef2c185465ac9f7d7f01ae9e8531355b9e70) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: fix bad linksNicolas Dechesne2020-09-162-2/+2
| | | | | | | | | | | | The link errors were found with linkcheck command: (line 1958) broken https://docs.python.org/3/library/re.html#re - Anchor 're' not found (line 713) broken http://docs.python.org/3/library/re.html#re - Anchor 're' not found (Bitbake rev: 29081375659e3dcf1c578cd98ab2c8a2e9f07ca8) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: theme_override: Use bold for emphasis textRichard Purdie2020-09-161-0/+4
| | | | | | | | | This more closely matches the original docbook style and is appropriate given the way the manual uses this element. (Bitbake rev: a0f37789493aeb1cd5e82c17459bfa4cf6c0ecd6) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: theme_override: properly set font for verbatim textNicolas Dechesne2020-09-161-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. (Bitbake rev: cbc5ca48c7e79c47f055a47f8f9aa480490dd00f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: remove leading '/'Nicolas Dechesne2020-09-161-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> (Bitbake rev: 08b1ae2350694e22883e07605a28a10c05f62cda) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: update style for important, caution and warningsNicolas Dechesne2020-09-161-2/+11
| | | | | | | | | The initial theme override covers for tip and and note only. (Bitbake rev: 99ba6fe98b9c7c4dbe70dce63c478c167c10d91a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: last manual round of fixes/improvementsNicolas Dechesne2020-09-166-1170/+1733
| | | | | | | | | | Review all pages, and fix up for formatting which was not covered by pandoc, such as some links and code block sections. (Bitbake rev: d99760cc687cc9c24d6d9a1c49fa094574476e0c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: bitbake-user-manual: insert additional blank line after titleNicolas Dechesne2020-09-165-0/+10
| | | | | | | (Bitbake rev: 4f94633a68fd44223d6be458fc0d3616dfdfd1a7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: add releases pageNicolas Dechesne2020-09-162-0/+131
| | | | | | | | | This page has a list of all the previously released Bitbake user manual. (Bitbake rev: 63adcaa527b931f4a9494729b26e40ddef8d3695) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: conf: enable extlinks extensionNicolas Dechesne2020-09-161-0/+6
| | | | | | | (Bitbake rev: 3e940d93c7513413a93a910122b1dd82870044b1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: index: move the boilerplate at the end of the pageNicolas Dechesne2020-09-161-10/+14
| | | | | | | (Bitbake rev: 9921c652340c1a3c06572603b2251a7ddea54b85) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: add SPDX headersNicolas Dechesne2020-09-167-0/+14
| | | | | | | (Bitbake rev: 4e461224c1825ebba6024fb8d962e726598da153) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: Enhance the sphinx experience/nagivation with:Richard Purdie2020-09-164-0/+264
| | | | | | | | | | | | * 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 (Bitbake rev: cb19159cf8972713a2063387849804c5cea72d24) 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>
* bitbake: sphinx: tweak html output a bitNicolas Dechesne2020-09-161-5/+11
| | | | | | | | | | | * Remove the 'generated by Sphinx' text on each page * Add a 'last updated timestamp' on each page * Remove the trailing 'dot' in TOC numbering (Bitbake rev: 10a54678bf7a119e91df8160b0f43384181d636d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: Makefile.sphinx: add clean and publish targetsNicolas Dechesne2020-09-161-1/+12
| | | | | | | (Bitbake rev: 219b2348f51a02b102cd1c34c87f279c83ae4908) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: fixes all remaining warningsNicolas Dechesne2020-09-163-11/+11
| | | | | | | | | This patch fixes a handful of remaining warnings reported by Sphinx. (Bitbake rev: 35fdc18549607e195d424f554e8d4b74e87fd245) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: fix links inside notesNicolas Dechesne2020-09-163-18/+13
| | | | | | | | | | For some notes with links, the links were lost during the pandoc conversion. (Bitbake rev: e11d2dd1adbcb35b45d6d0f3a47f8d06caab0b49) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: fixup for linksNicolas Dechesne2020-09-166-160/+160
| | | | | | | | | | | | | | | | | | | | | | | | Since we converted the list of variables into a Sphinx glossary, the automatic conversion from Pandoc does not produce proper links. We fix them up using a Python regexp. Similarly some http links were not converted correctly, and can also be fixed up with a regexp. This patch was generated by running the following regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) line = re.sub("`+(\w+)`* <#var-bb-\\1>`__", ":term:`\\1`", line) (Bitbake rev: 57300955beb200c81762880f44f1a499451b7432) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: override theme CSSNicolas Dechesne2020-09-162-1/+153
| | | | | | | | | | | | | It is possible to override CSS settings from the theme, by providing custom snippets of CSS stylesheet. Support for that is added in conf.py file. Most of the CSS customization is inherited from the DocBook CSS style. (Bitbake rev: fa304c0129538d7a0b7a3922cd1fde2e242d6cab) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: switch to readthedocs themeNicolas Dechesne2020-09-161-1/+1
| | | | | | | | | | To install this additional theme: pip3 install sphinx_rtd_theme (Bitbake rev: 29af1cd2a4f379096f5dd6f4cacc0a9c9f211e7c) 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 2025-08-12 23:47:55 +0000