You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thanks! If you could, can you add a short description of what the change would actually be? I'm still not quite sure what it means to "make sphinx use the current git branch".
akhmerov
changed the title
Document how to dynamically configure git branch
Document how to dynamically configure git branch in the binder URL
Aug 28, 2021
The user makes a PR introducing an API change to the library
The CI builds preview documentation for the PR. Because the docs are built in the checked out repo, everything works ✔️
The docs use sphinx-thebe thebe, which in turn is configured to use a binder URL.
State of the art:
Binder URL points to the default branch, and thebe fails in preview docs.
Possible improvement:
The binder URL is automatically determined during build, and the branch parameter of the binder URL is computed using something like git rev-parse --abbrev-ref HEAD. This ensures that the correct binder branch is used.
Link to the documentation you'd like to improve
https://sphinx-thebe.readthedocs.io/en/latest/configure.html
What to improve
After #17 is merged, we should document how to make sphinx provide the current git branch in generating the binder link.
Implementation
See #40 (comment) for some ides from @akhmerov
The text was updated successfully, but these errors were encountered: