mbox series

[0/2] doc: fix the switchers menu

Message ID 20250915-fix-switchers-js-v1-0-523ef53fe802@bootlin.com
Headers show
Series doc: fix the switchers menu | expand

Message

Antonin Godard Sept. 15, 2025, 12:19 p.m. UTC 
This series aims at fixing the switchers.js script of Bitbake to show
what are the supported versions and be able to switch between them. It
also get the current version from the environment, and shows it on the
sidebar. Moreover the "obsolete" warning is now shown when browsing an
outdated manual.

This also adds a set_versions.py script, which is largely inspired from
yocto-docs. This script replaces the version in switchers.js by the one
it finds in BITBAKE_ACTIVE_RELEASES (env variable passed from the
autobuilder).

IMPORTANT: must be merged with following series/patches:
- "set_versions.py: add bitbake-active-releases special argument" on
  the docs list
- "scripts/run-docs-build: improvements for the bitbake menu" on the
  yocto-autobuilder-helper/yocto-patches list

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (2):
      doc: fix and automate switchers.js versions
      doc/conf.py: get current version from env

 doc/.gitignore                    |   1 +
 doc/Makefile                      |   3 +-
 doc/conf.py                       |   5 +-
 doc/set_versions.py               |  53 ++++++++
 doc/sphinx-static/switchers.js    | 233 -----------------------------------
 doc/sphinx-static/switchers.js.in | 250 ++++++++++++++++++++++++++++++++++++++
 6 files changed, 310 insertions(+), 235 deletions(-)
---
base-commit: 546b347b4d3d82c01ecc99f45296f66e44638adc
change-id: 20241227-fix-switchers-js-8cf445610b97

Best regards,
--  
Antonin Godard <antonin.godard@bootlin.com>