Skip to content

Don't duplicate the sidebar button on Sphinx 5 and newer #127

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 25, 2023
Merged

Don't duplicate the sidebar button on Sphinx 5 and newer #127

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c6a817
Rename ``sidebar.js`` to be a static template file
AA-Turner Apr 20, 2023
d5d6285
Don't duplicate the sidebar button on Sphinx 5 and newer
AA-Turner Apr 20, 2023
d39c311
whitespace
AA-Turner Apr 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions python_docs_theme/static/sidebar.js → python_docs_theme/static/sidebar.js_t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ const initialiseSidebar = () => {
return
}

{# Check if we need to dynamically insert the sidebar button.
# We prefer the ``sphinx_version_tuple`` variable, and if it is undefined we
# know we are running a Sphinx version older than 4.2.
#
# See: https://www.sphinx-doc.org/en/master/development/templating.html#sphinx_version_tuple
#}
{% if sphinx_version_tuple is defined and sphinx_version_tuple[0] >= 5 %}
const sidebarButton = document.getElementById("sidebarbutton")
const sidebarArrow = sidebarButton.querySelector('span')
{% else %}
// create the sidebar button element
const sidebarButton = document.createElement("div")
sidebarButton.id = "sidebarbutton"
Expand All @@ -44,6 +54,7 @@ const initialiseSidebar = () => {
sidebarArrow.innerText = "«"
sidebarButton.appendChild(sidebarArrow)
sidebar.appendChild(sidebarButton)
{% endif %}

const collapse_sidebar = () => {
bodyWrapper.style.marginLeft = ".8em"
Expand Down