make switcher match gh-pages #2007
Merged
Conversation
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
Conengmo
added
the
documentation
merschformann
approved these changes
Oct 17, 2024
| break | ||
| if latest_index is None: | ||
| else: |
There was a problem hiding this comment.
I didn't even realize this kind of for / if / break / else combo was possible. TIL, interesting. 👍
Comment on lines
+87
to
+88
| destination_dir: latest | ||
| keep_files: false |
There was a problem hiding this comment.
If I read this correctly, these 2 lines will "re-deploy" to latest every time this executes, thus, having the latest docs always available in that dir. Nice and simple. Makes sense to me.
|
Thanks Marius! Appreciate you taking the time to take a look at this. I'll give this a try once we fixed the publish docs workflow. |
Conengmo
force-pushed
the
update-docs-versioning
branch
from
f342068 to
72d82a2
Compare
|
pre-commit.ci autofix |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
#1965 was a really helpful change to get our docs versioning updated automatically on release. It got us a large way there, but not fully. I noticed while the dropdown in the UI is updated correctly, it doesn't fully correspond to the folder situation on our
gh-pagesbranch. See https://github.com/python-visualization/folium/tree/gh-pages.The issue is we have a main
index.htmlthat redirects tolatest/index.html. To make things easy, we'd ideally not have to update this redirect, but always put the latest release version in thestablebranch.Furthermore, I'd like it if there are not two entries in the dropdown for the same version. So 'latest' should now refer to v0.17.0, and there shouldn't also be a v0.17.0 option. And 'latest' should make clear it refers to v0.17.0, by including a name like "latest (v0.17.0).
latest/.switcher.jsonto be prepared for the new version of the script.@merschformann don't know if you have time and are interested to review this one? Thanks again for your original work, made it easy to make this step.