Skip to content

Update docs Pages workflow to publish on releases with latest-tag default#103

Merged
nikivanstein merged 1 commit intomainfrom
feature/codex-add-sphinx-multiversion-support-to-docs
Mar 7, 2026
Merged

Update docs Pages workflow to publish on releases with latest-tag default#103
nikivanstein merged 1 commit intomainfrom
feature/codex-add-sphinx-multiversion-support-to-docs

Conversation

@nikivanstein
Copy link
Contributor

@nikivanstein nikivanstein commented Mar 6, 2026

I implemented (partly using codex) the multi-version documentation we spoke off.
This will help a lot in keeping track of features and releases.

Summary

  • Updated .github/workflows/docs2pages.yml triggers to run on both:
    • pushes to main (to keep the main docs variant fresh), and
    • published GitHub releases (to publish on release events).
  • Kept sphinx-multiversion as the docs build command.
  • Replaced root publishing behavior:
    • instead of always copying main to _site/, the workflow now selects the highest v* version folder (semantic version sort) as the site root default,
    • and only falls back to _site/main when no release-tag folders are present.

Behavior after this change

  • main/ docs are still generated and updated.
  • The default landing page (/index.html) now points to the latest released tag docs when available.
  • New release publication triggers docs deployment immediately.

@nikivanstein nikivanstein self-assigned this Mar 6, 2026
@nikivanstein nikivanstein added documentation Improvements or additions to documentation and removed codex labels Mar 6, 2026
@codecov
Copy link

codecov bot commented Mar 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@nikivanstein nikivanstein merged commit f76547a into main Mar 7, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant