Bug 14121 - Implement sphinx switchers.js for bitbake
Summary: Implement sphinx switchers.js for bitbake
Status: RESOLVED FIXED
Alias: None
Product: BitBake User Manual
Classification: Documentation
Component: bitbake-manual (show other bugs)
Version: 3.2
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 5.1 M2
Assignee: Michael Opdenacker
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2020-11-09 09:28 UTC by Nicolas Dechesne
Modified: 2024-06-11 13:11 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: No (bug/feature does not impact docs)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Nicolas Dechesne 2020-11-09 09:28:13 UTC 
In Sphinx docs, we added switchers.js to switch back and forth between:
* regular page view vs mega manual 'style' view
* all versions

However the implementation of switchers.js is rather specific to yocto-docs and does not work with with bitbake *if* we use bitbake versions (1.48 vs 3.2). 

So we should implement the 'version' switcher differently for bitbake or yocto-docs. 

An alternative would be to use the YP version for Bitbake user manual. e.g. in the 1.48 branch of bitbake, in conf.py set current_version to 3.2, not 1.48.
Comment 1 Randy MacLeod 2022-11-03 15:18:50 UTC 
Michael, can you work with Nico on this one?
Comment 2 Michael Opdenacker 2024-06-11 13:11:22 UTC 
We now have switchers.js (doc/sphinx-static/switchers.js) that make it possible to access the BitBake manual corresponding to a given Yocto release name.

See https://docs.yoctoproject.org/bitbake/2.8/index.html
Closing this bug.