Skip to content

Version the docs site and add a version picker - #115

Merged
doronz88 merged 1 commit into
mainfrom
docs/versioned-site
Nov 5, 2026
Merged

doronz88 merged 1 commit into
mainfrom
docs/versioned-site

Conversation

@doronz88

@doronz88 doronz88 commented Nov 5, 2026

Copy link
Copy Markdown
Owner

The docs site is now versioned with mike, like pymobiledevice3's:

  • Each published release publishes its X.Y series and moves the latest alias, which is the default, to it. A push to main publishes main.
  • The header gets a version picker. Every version except latest shows a banner linking to the latest release.
  • Pre-versioning URLs (README, PyPI, the web) keep working. .github/docs_root_redirects.py writes root redirects to the same page of the default version, keeping the #anchor, plus a 404 fallback and root copies of llms.txt/llms-full.txt.
  • The github-pages environment only deploys from main, so a release run pushes to gh-pages and then starts the workflow on main, which deploys.
  • og:image no longer breaks under mike's canonical_version (site_url loses its trailing slash).

Rehearsed locally, without pushing:

  • publish main, then a simulated 3.8 release, with the redirect script after each step;
  • strict build passes;
  • /installation/#x goes to /main/ before the first release and to /latest/installation/#x after it;
  • the picker shows main and 3.8 latest, and the banner shows on main only.

Until the next release only main exists, so the root points there.

@doronz88
doronz88 merged commit 0985188 into main Nov 5, 2026
4 checks passed
@doronz88
doronz88 deleted the docs/versioned-site branch November 5, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant