GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Don't duplicate the sidebar button on Sphinx 5 and newer by AA-Turner · Pull Request #127 · python/python-docs-theme

Conversation

@AA-Turner

@AA-Turner AA-Turner commented Apr 20, 2023

Copy link
Copy Markdown
Member

The sidebar button is included in the generated HTML from Sphinx 5 onwards (specifically, from sphinx-doc/sphinx@3b01fbe and the changes to themes/classic/layout.html).

We use the sphinx_version_tuple templating variable addded in Sphinx 4.2 to determine if we should add the sidebar button dynamically via JavaScript, or load the pre-existing button element from HTML.

I have tested locally on Sphinx 6.1.3, Sphinx 3.2.0, and Sphinx 4.5.0--all three display correct behaviour with respect to the sidebar.

A

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
AA-Turner added 2 commits April 20, 2023 22:27
@AA-Turner
Rename sidebar.js to be a static template file
0c6a817
@AA-Turner
Don't duplicate the sidebar button on Sphinx 5 and newer
d5d6285
@AA-Turner AA-Turner mentioned this pull request Apr 20, 2023
Releasing v2023.5 #126
Merged
@AA-Turner
AA-Turner requested review from JulienPalard and hugovk April 20, 2023 21:49
AA-Turner
AA-Turner commented Apr 20, 2023
View reviewed changes
Comment thread python_docs_theme/static/sidebar.js_t Resolved

Uh oh!

There was an error while loading. Please reload this page.
@AA-Turner
whitespace
d39c311
@AA-Turner

AA-Turner commented Apr 20, 2023

Copy link
Copy Markdown
Member Author

I've updated python/cpython#99381 to point to this PR, so that it installs Sphinx 6.1.3 and python-docs-theme as of this PR. The deploy preview seems to show that all is working as intended on newer Sphinx versions, and this PR's RTD preview shows it working on older Sphinx versions.

A
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AA-Turner AA-Turner mentioned this pull request Apr 20, 2023
GH-99380: Update to Sphinx 7 python/cpython#99381
Merged
@AA-Turner AA-Turner self-assigned this Apr 20, 2023
pradyunsg
pradyunsg approved these changes Apr 21, 2023
View reviewed changes
hugovk
hugovk approved these changes Apr 21, 2023
View reviewed changes
@hugovk
hugovk merged commit e3ef253 into python:main Apr 25, 2023
@AA-Turner

AA-Turner commented Apr 25, 2023

Copy link
Copy Markdown
Member Author

Thanks Hugo!

A
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AA-Turner
AA-Turner deleted the sphinx-5-fixup branch July 15, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes
@pradyunsg pradyunsg pradyunsg approved these changes
@JulienPalard JulienPalard Awaiting requested review from JulienPalard

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@AA-Turner AA-Turner

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@AA-Turner @hugovk @pradyunsg
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.