Publish versioned docs: stable at root, dev under /dev/#8
Open
TomaSusi wants to merge 1 commit into
Open
Conversation
Stable (release-built) docs remain the default at the site root; a new deploy-dev workflow publishes main to /dev/ on every docs push. The two versions cross-link via the footer (stable -> dev) and an announcement banner (dev -> stable), and dev pages carry a robots noindex tag so search engines only surface stable. The release deploy now carries the existing /dev/ tree forward so the two publish cadences don't clobber each other. Also tidies docs/requirements.txt (duplicates, unused sphinx_rtd_theme/ nbsphinx), removes the dead doc_requirements.txt, and points the repository buttons at abTEM/doc instead of the jupyter-book template. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
4 tasks
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
1 participant
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.
Summary
mainon every push, served under/dev/).deploy-book.yml(release trigger) now carries the existing/dev/tree forward into each new root snapshot instead of wiping it; a newdeploy-dev.ymlworkflow publishesmaininto/dev/only.abtem_version_footer.pyextended: dev builds get a warning banner +noindex(kept out of search); stable builds get a footer link to the dev docs. Controlled byABTEM_DOCS_VERSION(defaults tostable, so local/RTD builds are unaffected).docs/requirements.txt, removed deaddocs/doc_requirements.txt, fixed_config.yml's repository links (were pointing at thejupyter-booktemplate repo).Test plan
ABTEM_DOCS_VERSION=devand=stable(banner/noindex/footer link present only where expected)deploy-bookviaworkflow_dispatchto refresh the root with the new footer (the merge itself triggers the first/dev/deploy)🤖 Generated with Claude Code