Repository navigation
docs: backport version navigation to release-0.3 - #496
Merged
Merged
Conversation
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.
Purpose
Related issue: #491
Related main-branch PR: #492
Backport documentation version navigation to
release-0.3so the released documentation can participate in the versioned website layout.Add the version dropdown, read the shared version list published by main, and support
PAIMON_DOCS_VERSIONandPAIMON_DOCS_VERSIONS_URL. This release branch defaults to the stable channel with the warning banner disabled. An explicit0.3channel supports future archival. Keep the documentation version at0.3.0and point edit links atrelease-0.3.The branch's existing
versions.jsonremains unchanged because its release tools require the legacy metadata format. Navigation reads main's shared list instead.Tests
python3 -m unittest discover -s scripts/releasing/tests -p 'test_*.py'— 16 tests passed.python3 scripts/releasing/bump_version.py --check 0.3.0— passed.pre-commit run --files docs/source/conf.py— all applicable checks passed.git diff --check— passed.doxygen Doxyfile.PAIMON_DOCS_VERSION=stableand0.3, using Python 3.11.15, a browser-reachable localPAIMON_DOCS_VERSIONS_URL, andmake html SPHINXOPTS='-j8 -E -a -W --keep-going'with separate output directories.API and Format
No C++ public API, storage format, protocol, or release metadata format changes. Only Sphinx configuration changes.
Documentation
Adds version navigation to the existing 0.3.0 documentation without importing development-branch content. The production JSON endpoint and version directories require the main-branch and paimon-website publishing changes.
Generative AI tooling
Generated-by: OpenAI Codex (GPT-6)