Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enable pydata_sphinx_theme version banner #13901

Merged

Conversation

mosc9575
Copy link
Contributor

@mosc9575 mosc9575 commented May 17, 2024

This PR activates the version banner from pydata-sphinx-theme, removes the old version banner (js and css). The switcher.json in also adapted to silence a warning.

After running make clean html serve on my local machine this is the result.

version_banner

For the older versions

it is suggested to add the code below to all existing html pages to enable the banner.


<div style="background-color: rgb(248, 215, 218); color: rgb(114, 28, 36); text-align: center;">
  <div>
    <div>This is documentation for <strong>an old version</strong>.
      <a href="https://docs.bokeh.org/en/latest/index.html" style="background-color: rgb(220, 53, 69); color: rgb(255, 255, 255); margin: 1rem; padding: 0.375rem 0.75rem; border-radius: 4px; display: inline-block; text-align: center;">Switch to stable version</a>
    </div>
  </div>
</div>

I don't know how to do this.

@mosc9575 mosc9575 added this to the 3.5 milestone May 17, 2024
docs/bokeh/source/conf.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.15%. Comparing base (e61219b) to head (29d0e3a).
Report is 40 commits behind head on branch-3.5.

Additional details and impacted files
@@              Coverage Diff               @@
##           branch-3.5   #13901      +/-   ##
==============================================
+ Coverage       91.57%   93.15%   +1.58%     
==============================================
  Files             326      282      -44     
  Lines           20737    20031     -706     
==============================================
- Hits            18990    18660     -330     
+ Misses           1747     1371     -376     

@bryevdv
Copy link
Member

bryevdv commented May 17, 2024

it is suggested to add the code below to all existing html pages to enable the banner.

Unfortunately that would be an enormous ordeal and undertaking. Also potentially costly, as well, as the pages are stored on s3 and we would have to exfiltrate many tens of thousands to update. We would also have to issue very large Cloudfront cache invalidations. I think we will just have to live with old pages being as they are until they are retired from the switcher list.

Edit: Unless you mean just the top-level index.html pages and not anything else. Then sure, we can update a handful of pages manually.

@mosc9575
Copy link
Contributor Author

mosc9575 commented May 17, 2024

Edit: Unless you mean just the top-level index.html pages and not anything else. Then sure, we can update a handful of pages manually.

I haven't thought about updating only the start page but I think that would be a good compromise. It is not sufficent to show the version banner on all pages but it is much better than nothing and the start page should have this information.

@mosc9575 mosc9575 changed the title enable pydate_sphinx_theme version banner enable pydata_sphinx_theme version banner May 17, 2024
@bryevdv
Copy link
Member

bryevdv commented May 17, 2024

@bokeh/core after this is merged it would be advised to test a dev build release.

@bryevdv
Copy link
Member

bryevdv commented May 17, 2024

Thanks @mosc9575 FYI I am about to be "out of the office" for a few weeks, maybe make a separate issue regarding updating the old index.html pages manually so it doesn't get lost in the shuffle. If you happen to be able to update all the pages locally and store them off somewhere or in a zip file, etc., that I can access, that will definitely speed things up when I get back.

@mosc9575 mosc9575 merged commit e8caa13 into bokeh:branch-3.5 May 17, 2024
26 of 27 checks passed
@mosc9575 mosc9575 deleted the 13824_activate_pydata_theme_version_banner branch May 17, 2024 21:36
@mosc9575
Copy link
Contributor Author

@bryevdv Below is a zip folder with the adapted index pages. I adapted th current latest version, too. I hope this will work for you.

bokeh_start_pages.zip

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

activate pydata-sphinx-theme version banner
2 participants