summaryrefslogtreecommitdiffstats
path: root/documentation/sphinx-static
Commit message (Collapse)AuthorAgeFilesLines
* docs: sphinx-static: switchers.js.in: do not mark branches as outdatedQuentin Schulz2022-04-251-1/+1
| | | | | | | | | | | Branches can never be outdated so let's check the release is not a branch (branches end with .999). Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 4755961bbb5f674a7532b91cca20ea44a1e22ae7) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: fix broken switcher for branchesQuentin Schulz2022-04-251-0/+12
| | | | | | | | | | | | | | | | | | The switcher expects URL subpath to match the "release" used by sphinx to build the documentation. Branches, however, are put in a subpath after their name (e.g. dunfell) while sphinx sets the "release" to X.Y.999. This means the switcher cannot replace correctly the path to switch between releases/versions. Let set_versions.py inject the list of release names into the switchers.js.in file so it can check whether the subpath is one of the release names in which case it needs to be stripped. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 5ef3d129b8d0d8ae98a694103930988a46285525) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: rename all_versions to switcher_versionsQuentin Schulz2022-04-251-3/+3
| | | | | | | | | | | | | | This array only contains versions that can be selected through the dropdown menu for switching between supported versions. Therefore, let's rename it to switcher_versions to make its usecase clearer. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 5c3d67751bf3f572a0788d3a4734b80e3453d084) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: update Bitbake objects.inv location for master branchQuentin Schulz2022-04-251-4/+2
| | | | | | | | | | | | master branch of Bitbake is now located at docs.yoctoproject.org/dev instead of docs.yoctoproject.org so let's update the switchers and set_versions.py to reflect that change. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 18338292d99ed236e2bac6e73a5152ef11c4a9e5) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: improve obsolete version detectionQuentin Schulz2022-04-191-7/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | Based on additional information per release, specifically with the obsolescence status of a release, the obsolescence detection can now be much smarter than just checking if the release is older than dunfell. This is required because with LTS (dunfell for example) releases, it is now possible to have LTS releases that are older than obsolete releases. This means obsolete releases need to be tracked and only the release version cannot be used as an indicator of obsolescence. Let's use the obsolete field of the per-release data in the all_versions dictionary to display correct warning messages. The warning message is first about outdated version if there's a newer one available (*even* if it is for an obsolete release, e.g. 3.0.1 will say it's outdated and should select 3.0.4 version instead), then if the version is the last of the release, show a warning message if the release is obsolete. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 6986baa0d3b544bbad8a7e23ee447abc6f2769f6) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: add information about obsolescence of a releaseQuentin Schulz2022-04-191-6/+6
| | | | | | | | | | | | This adds support for marking releases as obsolete to make the detection algorithm smarter (in a later commit) than just checking if it's older than dunfell. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 6f40ef56054ecbd3d8b7310d748c1af78a689add) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: remove duplicate for outdated versionsQuentin Schulz2022-04-191-3/+0
| | | | | | | | | | | | | | | | | | | | | | Since commit f2b069be8c307 "set_versions: Various improvements", an outdated version will always appear in all_versions, meaning there'll always be an exact match in the loop (just above the git context of this patch) so there's no need to add the current_version to the dropdown menu manually. This issue showed up only for outdated versions of obsolete releases, e.g. 3.2.3. In that case, 3.2.4 (latest version of the obsolete release) will appear in the all_versions array in addition to 3.2.3, which means the check on release series (3.2) will be matched twice, and 3.2.3 will be printed once in the 3.2.4 loop because version != current_version and once in the 3.2.3 because it is an exact match to an entry in all_versions. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 05065fa1f3855e8b7d9e8af0502b4ae402273400) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* set_versions/switchers.js: Allow switchers.js version information to be ↵Richard Purdie2022-03-231-7/+1
| | | | | | | | | | | | | | | | 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>
* releases: update to include 3.1.15Michael Halstead2022-03-221-1/+1
| | | | | | | | | 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>
* releases: update to include 3.3.5Michael Halstead2022-03-031-1/+1
| | | | | | | | | 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>
* releases: update to include 3.4.2Michael Halstead2022-02-211-1/+1
| | | | | | | | | 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>
* releases: update to include 3.1.14Michael Halstead2022-02-171-1/+1
| | | | | | | | | 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>
* documentation: add comment to releases.rst switchers.jsMichael Opdenacker2022-01-071-0/+8
| | | | | | | | | | 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>
* releases: update to include 3.1.13Michael Halstead2022-01-031-1/+1
| | | | | | | | | 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>
* releases: update to include 3.4.1Michael Halstead2021-12-121-1/+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>
* documentation: prepare for 3.1.12 releaseMichael Opdenacker2021-11-211-1/+1
| | | | | | | (From yocto-docs rev: d97525982602db05e31b89a9076c93420974fd68) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.4Michael Halstead2021-11-191-1/+1
| | | | | | | | | 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>
* releases: update to include 3.4 honisterMichael Halstead2021-10-261-1/+2
| | | | | | | | | 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>
* releases: update to include 3.1.11Michael Halstead2021-09-281-1/+1
| | | | | | | | | 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>
* releases: update to include 3.3.3Michael Halstead2021-09-181-1/+1
| | | | | | | | | 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>
* releases: update to include 3.1.10Michael Halstead2021-08-111-1/+1
| | | | | | | | | 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>
* releases: update to include 3.3.1Michael Halstead2021-08-041-1/+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>
* releases: update to include 3.1.9Michael Halstead2021-07-021-1/+1
| | | | | | | | | 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>
* releases: update to include 3.1.8Michael Halstead2021-06-021-1/+1
| | | | | | | | | 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>
* releases: update to include 3.3.1Michael Halstead2021-05-251-1/+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>
* releases: update to include 3.2.4Michael Halstead2021-05-181-1/+1
| | | | | | | | | 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>
* Adding dunfell 3.1.7 to the switcher and release list.Vineela Tummalapalli2021-04-231-1/+1
| | | | | | | (From yocto-docs rev: bed221137de77340280d71b4a8b0f2f60addc566) Signed-off-by: Vineela Tummalapalli <vineela.tummalapalli@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3Michael Halstead2021-04-201-1/+2
| | | | | | | | | 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>
* releases: update to include 3.2.3Michael Halstead2021-04-061-1/+1
| | | | | | | | | 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>
* releases: update to include 3.1.6Michael Halstead2021-02-261-1/+1
| | | | | | | (From yocto-docs rev: 05580e574e78039f577d58648b4ee3817c0f09cc) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.2.2Michael Halstead2021-02-261-1/+1
| | | | | | | (From yocto-docs rev: 1770c9c1e1ce9d28f6d211061010c4a802522c16) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.53.3_M2Michael Halstead2021-01-201-1/+1
| | | | | | | (From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: conf: add link to 3.2.1, update to include 3.2.1Michael Halstead2020-12-151-1/+1
| | | | | | | (From yocto-docs rev: b268b1b190861cb203fa642e57794acb402280a7) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: conf: add link to 3.1.4, update to include 3.1.4Michael Halstead2020-12-031-1/+1
| | | | | | | (From yocto-docs rev: 20b7be912040ae02fb2df652fb79b09dd5f281e8) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf: update for release 3.2Nicolas Dechesne2020-11-091-1/+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>
* sphinx: add 3.1.3 and 3.0.4 release in the switcherNicolas Dechesne2020-10-261-2/+2
| | | | | | | (From yocto-docs rev: 64c7cb54e031b5b0babc8ee33dac0b9162a5f391) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UKRichard Purdie2020-10-081-1/+1
| | | | | | | | | | | 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>
* 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>
* 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: 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: 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: 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: Add support for multiple docs versionRichard Purdie2020-09-171-0/+233
| | | | | | | | | | | | 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: add Yocto project logoNicolas Dechesne2020-09-171-0/+0
| | | | | | | (From yocto-docs rev: 125c70b04a28bf095ed1cd8273ebdc7d1d0b5cfd) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add CSS theme overrideNicolas Dechesne2020-09-171-0/+146
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-06-24 15:38:23 +0000