Repository navigation
Render the banner and switchers in the theme, and drop the settings it now provides - #1761
Merged
Merged
Conversation
…pache's server-side includes The theme reads a versions.json served next to the documentation root, which any host can serve, in place of the `$BANNER` and version-options includes that Apache's mod_include resolves at request time. `versions_url` defaults to it, so only the block goes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UAeUtu5XGYmmSwtyjVU7gL
The option also emits relative links as the no-JavaScript fallback, in place of a form posted to
`{root}/{version}/switcher`.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UAeUtu5XGYmmSwtyjVU7gL
The theme registers itself and its catalogs through the `sphinx.html_themes` entry point, and defaults the options that every documentation repository set alike, ships the favicon, and adds the privacy notice to its footer. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UAeUtu5XGYmmSwtyjVU7gL
jpmckinney
force-pushed
the
theme-migration-1.1
branch
2 times, most recently
from
October 9, 2026 00:33
fa6c902 to
2467afa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Renders the sidebar's banner and switchers in the theme instead of through Apache's
mod_include, and drops the settings the theme now provides. Phase 1 of open-contracting/deploy#266 (comment).This is the branch that reaches the live documentation. #1755 is the same four commits cherry-picked onto
1.2-dev, so that 1.2 doesn't ship without them.What this replaces
<!--#include virtual="$BANNER" -->, resolved per path bySetEnv BANNERversions.json<!--#include virtual="/includes/version-options.html" -->versions.json/{version}/switcher, rewritten from the HTTP referer<noscript>links as the fallbackhtml_theme_path,locale_dirs,html_favicon,analytics_id,copyright,license_name,license_url,docs/_templates/footer.htmlsphinx.html_themesentry pointversions.jsonis served bysalt/docs/init.slsin the deploy repository, already applied. It stays a deployment artifact, edited on release, so that a new version reaches the pages of every earlier version without rebuilding them.The resulting
html_theme_optionsmatchesstandard_profile_template@latestapart fromdisplay_versionand the three languages.One deliberate loss
The
language_optionsblock wrapped the languages in<optgroup label="Supported translations">. A flatlanguagesdict can't express that, so the grouping goes. It has labelled every option since Italian was removed in 3108313 (2021-05-08), so nothing is distinguished by it today — but a future community translation would sit among the supported ones unmarked. open-contracting/standard-development-handbook#295 tracks that, along with the procedure that still tells you to edit the deleted block.Verified
Built all three languages from a clean install of the theme from
open_contracting, as CI does:<!--#includein the output, andpytest -W errorpassesdata-site="HTWZHRIZ"and the licence all still render, now from the themeVersión/IdiomaandVersion/Langue— because the theme's catalogs ship now;Nextwas untranslated on the Spanish documentation of every root before this../../../es/schema/release/🤖 Generated with Claude Code