1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 05:09:24 +00:00
Commit Graph

39 Commits

Author SHA1 Message Date
Richard Purdie 8827704443 set_versions/switchers.js: Allow switchers.js version information to be autogenerated
A horrible blunt hammer approach to updating the version information in
switchers.js based on the available tag information.

To merge and work correctly, this will need a change to the autobuilder-helper
docs generation code to pull the swicthers.js and script from master, then
to run the script. That should hopefully remove the need for other patching
even on old docs branches though.

(From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Michael Halstead c41172d837 releases: update to include 3.1.15
Adding 3.1.15 to documentation switcher and release list.

(From yocto-docs rev: 355dd1e3f5bf76244a0b5862475cb06ace1c87b9)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-22 22:32:34 +00:00
Michael Halstead 0447aace57 releases: update to include 3.3.5
Adding 3.3.5 to documentation switcher and release list.

(From yocto-docs rev: 78545b8f42657c21bc3cac96429d3950b07a3aca)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-03 09:19:58 +00:00
Michael Halstead 41ae26ecab releases: update to include 3.4.2
Adding 3.4.2 to documentation switcher and release list.

(From yocto-docs rev: 6ffc51362a8fd028429359eb9da57c87b270584d)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-21 16:46:22 +00:00
Michael Halstead d09e2e05a0 releases: update to include 3.1.14
Adding 3.1.14 to documentation switcher and release list.

(From yocto-docs rev: 4b2cfbc517208d6df40104d25e62f8febdd76a7f)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-17 11:47:24 +00:00
Michael Opdenacker dd938fbbdb documentation: add comment to releases.rst switchers.js
To let release developers know that they don't need
to update these files in release branches other than "master".

(From yocto-docs rev: 00f71afae92e5967a0422824841d4d4db682d235)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Halstead 56e5054a60 releases: update to include 3.1.13
Adding 3.1.13 to documentation switcher and release list.

(From yocto-docs rev: 24fe6a752cdec66a3d34d390fa645726ed3725b8)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-03 22:17:18 +00:00
Michael Halstead 14cb87f9ae releases: update to include 3.4.1
Adding 3.4.1 to documentation switcher and release list.

(From yocto-docs rev: 7d503d765f5a8ade226c897a17aecd0856104af1)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-12 11:27:24 +00:00
Michael Opdenacker 2a550cceae documentation: prepare for 3.1.12 release
(From yocto-docs rev: d97525982602db05e31b89a9076c93420974fd68)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Michael Halstead 63dc9002b6 releases: update to include 3.3.4
Adding 3.3.4 to documentation switcher and release list.

(From yocto-docs rev: 468e8bfb4b9bed662f1b32b0563339d0816a7e98)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-19 11:05:20 +00:00
Michael Halstead 0d4c97c24d releases: update to include 3.4 honister
Adding 3.4 to the release switcher and incrementing dev to say 3.5.

(From yocto-docs rev: a171e88bc572e45d700d257a9de521520b4d5d5e)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-26 14:04:19 +01:00
Michael Halstead 0afeb9f740 releases: update to include 3.1.11
Adding 3.1.11 to documentation switcher and release list.

(From yocto-docs rev: 29fb29547322520698b13a4d7c94dbb8defa93b1)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-28 07:49:57 +01:00
Michael Halstead ab55ae5d39 releases: update to include 3.3.3
Adding 3.3.3 to documentation switcher and release list.

(From yocto-docs rev: cc88f73ea0e38f536cb3e05b504df80048856a84)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:35:32 +01:00
Michael Halstead 77ce05bd36 releases: update to include 3.1.10
Adding 3.1.10 to documentation switcher and release list.

(From yocto-docs rev: 86b44b72c366f56d6977e7462aca8821721d89bd)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-11 20:41:54 +01:00
Michael Halstead f64b796093 releases: update to include 3.3.1
Adding 3.3.1 to documentation switcher and release list.

(From yocto-docs rev: 3c98afb0fefd889e8036639d9a2c775b73b237c2)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-04 11:20:48 +01:00
Michael Halstead bc164bd86a releases: update to include 3.1.9
Adding 3.1.9 to documentation switcher and release list.

(From yocto-docs rev: 6951b86a2e0e95bb72db12624efa23fec579bc70)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-02 07:24:21 +01:00
Michael Halstead b5d761583e releases: update to include 3.1.8
Adding 3.1.8 to documentation switcher and release list.

(From yocto-docs rev: 657408bf30279b44f1e1255787a2c56b739df142)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Michael Halstead c23a25e607 releases: update to include 3.3.1
Adding 3.3.1 to documentation switcher and release list.

(From yocto-docs rev: db80bb70d9bea7008cb6b2795c8f617b1486ca03)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-25 22:26:34 +01:00
Michael Halstead ed2d99203d releases: update to include 3.2.4
Adding 3.2.4 to documentation switcher and release list.

(From yocto-docs rev: b24cddff0f1367360441e3f9ff59cbed77da28ad)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-18 12:53:08 +01:00
Vineela Tummalapalli 1ea11c5c20 Adding dunfell 3.1.7 to the switcher and release list.
(From yocto-docs rev: bed221137de77340280d71b4a8b0f2f60addc566)

Signed-off-by: Vineela Tummalapalli <vineela.tummalapalli@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-23 16:39:03 +01:00
Michael Halstead 6204a3f5f4 releases: update to include 3.3
Adding Hardknott to documentation switcher and release list.

(From yocto-docs rev: d1578f6ae84d0c44c63632bd5f3146653f1310a3)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-20 14:04:56 +01:00
Michael Halstead e8e10f27b2 releases: update to include 3.2.3
Updating to build 3.2.3 docs and add missing 3.0.4 release line.

(From yocto-docs rev: 95972458c4c5ecea38676975f69afca7f0c91e35)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 09:45:39 +01:00
Michael Halstead 41ee3602ed releases: update to include 3.1.6
(From yocto-docs rev: 05580e574e78039f577d58648b4ee3817c0f09cc)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26 22:36:56 +00:00
Michael Halstead 5f69bf12e5 releases: update to include 3.2.2
(From yocto-docs rev: 1770c9c1e1ce9d28f6d211061010c4a802522c16)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26 15:21:21 +00:00
Michael Halstead b5e634644b releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.5
(From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 22:50:45 +00:00
Michael Halstead 82b8dc9ccc releases: conf: add link to 3.2.1, update to include 3.2.1
(From yocto-docs rev: b268b1b190861cb203fa642e57794acb402280a7)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-15 23:03:47 +00:00
Michael Halstead b3f533aec7 releases: conf: add link to 3.1.4, update to include 3.1.4
(From yocto-docs rev: 20b7be912040ae02fb2df652fb79b09dd5f281e8)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:20 +00:00
Nicolas Dechesne f075071761 conf: update for release 3.2
switchers.js:
* add 3.2 release
* update 'dev' to 3.3

(From yocto-docs rev: f8b5e11bf31f2df9d86abfa5f7fcf7f3d66a4f85)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-09 13:16:13 +00:00
Nicolas Dechesne 1dfd37d309 sphinx: add 3.1.3 and 3.0.4 release in the switcher
(From yocto-docs rev: 64c7cb54e031b5b0babc8ee33dac0b9162a5f391)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26 22:12:42 +00:00
Richard Purdie fe74a4edd2 docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK
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>
2020-10-08 11:28:30 +01:00
Quentin Schulz 17333a9162 docs: static: theme_overrides.css: fix responsive design on <640px 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.

(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>
2020-09-22 09:58:48 +01:00
Richard Purdie 90a47a9c5b sphinx: theme_override: Use bold for emphasis text
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>
2020-09-17 10:09:35 +01:00
Nicolas Dechesne d072e879e5 sphinx: theme_override: add tying-it-together admonition
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>
2020-09-17 10:09:35 +01:00
Nicolas Dechesne 0a85ac5708 sphinx: theme_override: properly set font for verbatim text
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>
2020-09-17 10:09:35 +01:00
Nicolas Dechesne 9f0a31c607 sphinx: update style for important, caution and warnings
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>
2020-09-17 10:09:35 +01:00
Nicolas Dechesne d313d972bf sphinx: remove leading '/'
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>
2020-09-17 10:09:35 +01:00
Richard Purdie ad2e3e6146 sphinx: Add support for multiple docs version
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>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne fd71ce03e9 sphinx: add Yocto project logo
(From yocto-docs rev: 125c70b04a28bf095ed1cd8273ebdc7d1d0b5cfd)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne 2c3298d72e sphinx: add CSS theme override
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.

The following changes are made:
* remove the overall text width which (set to 800px by default)
* improve the visual output, and colors of links and admonition

(From yocto-docs rev: 0c1e108bc6c452f7cc8c665bee984bd7da281666)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00