Skip to content

docs: handle common case where ExampleNotebooks already exists and is on a tag - #1735

Merged
mikemhenry merged 1 commit into
mainfrom
docs/fix_example_notebook_sync
Dec 4, 2025
Merged

mikemhenry merged 1 commit into
mainfrom
docs/fix_example_notebook_sync

Conversation

@atravitz

@atravitz atravitz commented Dec 4, 2025

Copy link
Copy Markdown
Contributor

root cause of these failures: https://github.com/OpenFreeEnergy/ExampleNotebooks/actions/workflows/openfe-doc-build.yaml

now that we clone from a specific release, this is more common and causes docs builds to fail with that warning.

Checklist

  • All new code is appropriately documented (user-facing code must have complete docstrings).
  • Added a news entry, or the changes are not user-facing.
  • Ran pre-commit by making a comment with pre-commit.ci autofix before requesting review.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

Developers certificate of origin

@atravitz
atravitz requested a review from mikemhenry December 4, 2025 16:52
@github-actions

github-actions Bot commented Dec 4, 2025

Copy link
Copy Markdown

No API break detected ✅

@atravitz

atravitz commented Dec 4, 2025

Copy link
Copy Markdown
Contributor Author

testing on the ExampleNotebooks side here: OpenFreeEnergy/ExampleNotebooks#271

Comment thread docs/conf.py
repo = Repo.clone_from(
repo = git.Repo.clone_from(
"https://github.com/OpenFreeEnergy/ExampleNotebooks.git",
branch="2025.10.2",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idea for the future: this should point to the stable release branch so we don't have to remember to update this for each release

@mikemhenry
mikemhenry merged commit bd7c683 into main Dec 4, 2025
4 checks passed
@mikemhenry
mikemhenry deleted the docs/fix_example_notebook_sync branch December 4, 2025 19:37
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.

2 participants