linux/poky.git/documentation/conf.py, branch hardknott-3.3

documentation: Prevent building documentation with an outdated version of sphinx

2021-01-20T00:53:53+00:00

Building with a outdated version of Sphinx print warnings that does not appear on up-to-date sphinx. This patch prevent building the documentation with any version older than 3.1 (First version to build without warnings in my tests) See threads "documentation: Add a simple Sphinx extension to check its version" https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516 and "toaster-manual: Fix a warning related to the code-block directive" https://lists.yoctoproject.org/g/docs/topic/patch_toaster_manual_fix_a/79656195 (From yocto-docs rev: 4de0f3dd4d5df0a0700f704a599bb41726d15a5f) Signed-off-by: Yoann Congal Signed-off-by: Richard Purdie

documentation: Simplify remaining yocto_home links

2020-12-24T08:23:33+00:00

(From yocto-docs rev: e0151e039f96c1548e2ec39ae24d4b0276f49434) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

documentation: Simplify layerindex and layer links

2020-12-24T08:23:33+00:00

(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

documentation: Simplify oe_wiki and oe_home links

2020-12-24T08:23:33+00:00

(From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

documentation: Simplify yocto_git links

2020-12-03T12:04:21+00:00

The yocto_git external link directive is modified to include the `/cgit/cgit.cgi` element of the URL so that we can simplify the links in the text. Manual links to git.yoctoproject.org are converted to use the yocto_git directive where possible. Note that this directive can't be used in some places such as example code. (From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7) Signed-off-by: Paul Barker Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

documentation: Simplify yocto_wiki links

2020-12-03T12:04:21+00:00

The `yocto_wiki` external link directive is modified to include the `/wiki` element of the URL so that we can simplify the links in the text. Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in index.rst. (From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d) Signed-off-by: Paul Barker Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

conf.py: Add oe_git directive

2020-11-20T14:32:25+00:00

This simplifies linking to git repositories on openembedded.org. (From yocto-docs rev: 03e13ca4d013e7712216a66eb4cdeb4a456be6a9) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

conf.py: Improve TOC and Outline depth in PDF output

2020-11-13T14:36:51+00:00

The default PDF output shows only chapter headings in the table of contents and in the outline (aka PDF bookmarks). We should override these defaults to set something more suitable. With a depth of 2 for the TOC we see both section and subsection headings which is enough to get the list of classes in the reference manual and the list of topics under "Common Tasks" in the development manual. Going to a deeper level would make the TOC unwieldy but we do want to make sure we can navigate more precisely using the outline (commonly shown in a left tab in PDF viewers) so we set the depth to 5 for the outline. (From yocto-docs rev: 5db16d3b01da0a138b6413347fcf2321a1bfae08) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

adt-manual: delete obsolete ADT manual, and related content

2020-10-30T16:03:19+00:00

Since the ADT manual has long been superseded by the SDK manual, remove the entire adt-manual directory, and the references to it in the two top-level files "conf.py" and "poky.yaml". (From yocto-docs rev: 64b2e83bddf6af0439ac7089ac95e60faa696cfc) Signed-off-by: Robert P. J. Day Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK

2020-10-08T10:28:30+00:00

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