Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: use 'version_selector' instead of 'display_version' which is deprecated by sphinx-rtd-theme 3.0.0 #10954

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

rouault
Copy link
Member

@rouault rouault commented Oct 7, 2024

No description provided.

@rouault rouault force-pushed the doc_update_for_rtd_3_0_0 branch from 874c0ba to c418dde Compare October 7, 2024 11:04
@rouault
Copy link
Member Author

rouault commented Oct 7, 2024

hum, the version selector appears as white-over-white... any idea @dbaston ?

@rouault
Copy link
Member Author

rouault commented Oct 7, 2024

ok, I'm merging this to avoid pull requests to be "red". Attempt at sticking to sphinx-rtd-theme 2.0 done in #10956 doesn't lead to better results...

@rouault rouault merged commit 37fec09 into OSGeo:master Oct 7, 2024
34 of 35 checks passed
@rouault
Copy link
Member Author

rouault commented Oct 7, 2024

The backport to release/3.9 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply c418dde090... Doc: use 'version_selector' instead of 'display_version' which is deprecated by sphinx-rtd-theme 3.0.0
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config advice.mergeConflict false"

stdout
CONFLICT (modify/delete): .github/workflows/doc_checks.yml deleted in HEAD and modified in c418dde090 (Doc: use 'version_selector' instead of 'display_version' which is deprecated by sphinx-rtd-theme 3.0.0).  Version c418dde090 (Doc: use 'version_selector' instead of 'display_version' which is deprecated by sphinx-rtd-theme 3.0.0) of .github/workflows/doc_checks.yml left in tree.
Auto-merging doc/source/conf.py

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-release/3.9 release/3.9
# Navigate to the new working tree
cd .worktrees/backport-release/3.9
# Create a new branch
git switch --create backport-10954-to-release/3.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick c418dde0908dcb7187b54788f9b9b380f7b4c31c,5de2b509ad7664c1e08cc7dbcb8532be7b9fa49c
# Push it to GitHub
git push --set-upstream origin backport-10954-to-release/3.9
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-release/3.9

Then, create a pull request where the base branch is release/3.9 and the compare/head branch is backport-10954-to-release/3.9.

@rouault
Copy link
Member Author

rouault commented Oct 7, 2024

first commit manually backported to 3.9 per 501754d

@dbaston
Copy link
Member

dbaston commented Oct 8, 2024

hum, the version selector appears as white-over-white... any idea @dbaston ?

Just getting to this now, but gdal.org looks OK to me. Let me know if there's still anything for me to look into.

@rouault
Copy link
Member Author

rouault commented Oct 8, 2024

Just getting to this now, but gdal.org looks OK to me. Let me know if there's still anything for me to look into.

yes, I believe we're good now. See #10680 (comment) for related changes (didn't want to step over your toes on this, but CI got broken because of the sphinx-rtd-theme 3.0.0 update and one thing led to another... including my struggling with CSS 🤮)

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