Add versioned docs via separate flygym-docs repo - #300
Open
sibocw wants to merge 4 commits into
Open
Conversation
- Add mike>=2.0 to dev deps for versioned gh-pages deploys - Enable the MkDocs Material version-switcher (extra.version.provider: mike) - Rewrite push_doc_site.sh: reads version from pyproject.toml, prompts to confirm or override the label (e.g. "2.1.1 (dev)"), and asks whether to update the 'latest' alias; replaces the manual git-init/force-push block with mike deploy targeting the NeLy-EPFL/flygym-docs remote Closes #299 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
sibocw
added
documentation
mike's -f flag is unrecognized; the correct short form for --config-file is -F. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Implements the plan from #299.
Changes
pyproject.toml/uv.lock: addmike>=2.0to dev deps (mike 2.2.0resolved)properdocs.yml: enable the MkDocs Material version-switcher (extra.version.provider: mike)scripts/dev/push_doc_site.sh: replaces the manual git-init/force-push block withmike deployNew deploy flow
push_doc_site.shnow:pyproject.tomlautomatically2.1.1 (dev)for a pre-release preview)latestalias (answernfor dev deploys)flygym-docsremote exists in the local repo, adding it if notmike deploy --push --remote flygym-docs -f properdocs.yml ...mikecalls themkdocsentry point internally;properdocsregisters itself as bothmkdocsandproperdocsin the venv, so no compatibility shim is needed.One-time setup still required
Before this script can be used:
NeLy-EPFL/flygym-docs, enable GitHub Pages on itCNAME(neuromechfly.org) file to the new repouv run mike set-default --push --remote flygym-docs latestTest plan
NeLy-EPFL/flygym-docsand enable GitHub Pagespush_doc_site.shfor a dev label (2.1.1 (dev)), answernto latest alias — verify versioned subdirectory appears on the docs repo2.1.1, answeryto latest — verify version switcher shows both entries and/redirects to2.1.1🤖 Generated with Claude Code