* [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu @ 2021-01-11 12:09 Quentin Schulz 2021-01-11 12:11 ` [docs] " Quentin Schulz 0 siblings, 1 reply; 4+ messages in thread From: Quentin Schulz @ 2021-01-11 12:09 UTC (permalink / raw) To: docs; +Cc: Quentin Schulz Up until now, only the version of a Yocto release was printed, which isn't very user-friendly. Add the release name too so that it's obvious to users which release of Yocto the currently open docs are applying to. Signed-off-by: Quentin Schulz <foss@0leil.net> --- documentation/sphinx-static/switchers.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js index 754de2e6a..fd4dd607d 100644 --- a/documentation/sphinx-static/switchers.js +++ b/documentation/sphinx-static/switchers.js @@ -3,10 +3,10 @@ var all_versions = { 'dev': 'dev (3.3)', - '3.2.1': '3.2.1', - '3.1.4': '3.1.4', - '3.0.4': '3.0.4', - '2.7.4': '2.7.4', + '3.2.1': 'gatesgarth (3.2.1)', + '3.1.4': 'dunfell (3.1.4)', + '3.0.4': 'zeus (3.0.4)', + '2.7.4': 'warrior (2.7.4)', }; var all_doctypes = { -- 2.29.2 ^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [docs] [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu 2021-01-11 12:09 [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu Quentin Schulz @ 2021-01-11 12:11 ` Quentin Schulz 2021-01-11 17:07 ` Peter Kjellerstedt 0 siblings, 1 reply; 4+ messages in thread From: Quentin Schulz @ 2021-01-11 12:11 UTC (permalink / raw) To: Quentin Schulz; +Cc: docs Hi all, Couldn't test properly on a local server so might want to keep an eye on it. As usual, css or js files changes aren't picked up by sphinx so you need to rebuild from scratch. When/If it gets approved, let me know so I can send backport patches. Cheers, Quentin On Mon, Jan 11, 2021 at 01:09:38PM +0100, Quentin Schulz wrote: > Up until now, only the version of a Yocto release was printed, which > isn't very user-friendly. > > Add the release name too so that it's obvious to users which release of > Yocto the currently open docs are applying to. > > Signed-off-by: Quentin Schulz <foss@0leil.net> > --- > documentation/sphinx-static/switchers.js | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js > index 754de2e6a..fd4dd607d 100644 > --- a/documentation/sphinx-static/switchers.js > +++ b/documentation/sphinx-static/switchers.js > @@ -3,10 +3,10 @@ > > var all_versions = { > 'dev': 'dev (3.3)', > - '3.2.1': '3.2.1', > - '3.1.4': '3.1.4', > - '3.0.4': '3.0.4', > - '2.7.4': '2.7.4', > + '3.2.1': 'gatesgarth (3.2.1)', > + '3.1.4': 'dunfell (3.1.4)', > + '3.0.4': 'zeus (3.0.4)', > + '2.7.4': 'warrior (2.7.4)', > }; > > var all_doctypes = { > -- > 2.29.2 > > > > -- StreamUnlimited Engineering GmbH High Tech Campus Vienna, Gutheil-Schoder-Gasse 10, 1100 Vienna, Austria Fax: +43 1 667 20 02 4401 quentin.schulz@streamunlimited.com, www.streamunlimited.com ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [docs] [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu 2021-01-11 12:11 ` [docs] " Quentin Schulz @ 2021-01-11 17:07 ` Peter Kjellerstedt 2021-01-12 9:19 ` Quentin Schulz 0 siblings, 1 reply; 4+ messages in thread From: Peter Kjellerstedt @ 2021-01-11 17:07 UTC (permalink / raw) To: Quentin Schulz, Quentin Schulz; +Cc: docs@lists.yoctoproject.org > -----Original Message----- > From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf > Of Quentin Schulz > Sent: den 11 januari 2021 13:12 > To: Quentin Schulz <foss@0leil.net> > Cc: docs@lists.yoctoproject.org > Subject: Re: [docs] [PATCH] documentation: sphinx-static: switchers.js: > add release name in dropdown menu > > Hi all, > > Couldn't test properly on a local server so might want to keep an eye on > it. > > As usual, css or js files changes aren't picked up by sphinx so you need > to rebuild from scratch. > > When/If it gets approved, let me know so I can send backport patches. > > Cheers, > Quentin > > On Mon, Jan 11, 2021 at 01:09:38PM +0100, Quentin Schulz wrote: > > Up until now, only the version of a Yocto release was printed, which > > isn't very user-friendly. > > > > Add the release name too so that it's obvious to users which release of > > Yocto the currently open docs are applying to. > > > > Signed-off-by: Quentin Schulz <foss@0leil.net> > > --- > > documentation/sphinx-static/switchers.js | 8 ++++---- > > 1 file changed, 4 insertions(+), 4 deletions(-) > > > > diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js > > index 754de2e6a..fd4dd607d 100644 > > --- a/documentation/sphinx-static/switchers.js > > +++ b/documentation/sphinx-static/switchers.js > > @@ -3,10 +3,10 @@ > > > > var all_versions = { > > 'dev': 'dev (3.3)', > > - '3.2.1': '3.2.1', > > - '3.1.4': '3.1.4', > > - '3.0.4': '3.0.4', > > - '2.7.4': '2.7.4', > > + '3.2.1': 'gatesgarth (3.2.1)', > > + '3.1.4': 'dunfell (3.1.4)', > > + '3.0.4': 'zeus (3.0.4)', > > + '2.7.4': 'warrior (2.7.4)', Since these are names, wouldn't it be more appropriate to capitalize them: '3.2.1': 'Gatesgarth (3.2.1)', '3.1.4': 'Dunfell (3.1.4)', '3.0.4': 'Zeus (3.0.4)', '2.7.4': 'Warrior (2.7.4)', > > }; > > > > var all_doctypes = { > > -- > > 2.29.2 //Peter ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [docs] [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu 2021-01-11 17:07 ` Peter Kjellerstedt @ 2021-01-12 9:19 ` Quentin Schulz 0 siblings, 0 replies; 4+ messages in thread From: Quentin Schulz @ 2021-01-12 9:19 UTC (permalink / raw) To: Peter Kjellerstedt; +Cc: Quentin Schulz, docs@lists.yoctoproject.org Hi Peter, On Mon, Jan 11, 2021 at 05:07:49PM +0000, Peter Kjellerstedt wrote: [...] > > On Mon, Jan 11, 2021 at 01:09:38PM +0100, Quentin Schulz wrote: [...] > > > diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js > > > index 754de2e6a..fd4dd607d 100644 > > > --- a/documentation/sphinx-static/switchers.js > > > +++ b/documentation/sphinx-static/switchers.js > > > @@ -3,10 +3,10 @@ > > > > > > var all_versions = { > > > 'dev': 'dev (3.3)', > > > - '3.2.1': '3.2.1', > > > - '3.1.4': '3.1.4', > > > - '3.0.4': '3.0.4', > > > - '2.7.4': '2.7.4', > > > + '3.2.1': 'gatesgarth (3.2.1)', > > > + '3.1.4': 'dunfell (3.1.4)', > > > + '3.0.4': 'zeus (3.0.4)', > > > + '2.7.4': 'warrior (2.7.4)', > > Since these are names, wouldn't it be more appropriate to capitalize them: > > '3.2.1': 'Gatesgarth (3.2.1)', > '3.1.4': 'Dunfell (3.1.4)', > '3.0.4': 'Zeus (3.0.4)', > '2.7.4': 'Warrior (2.7.4)', > Yup, thanks for the review. In the end, we'll go for a more generic approach so that bitbake and yocto docs can both share switchers.js and use a configuration file to fill the dropdown menu. I'll try to not forget about this review :) We can drop this patch for now. Cheers, Quentin ^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-01-12 9:19 UTC | newest] Thread overview: 4+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2021-01-11 12:09 [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu Quentin Schulz 2021-01-11 12:11 ` [docs] " Quentin Schulz 2021-01-11 17:07 ` Peter Kjellerstedt 2021-01-12 9:19 ` Quentin Schulz
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.