use pathlib path in sitemap plugin for sphinx compatibility #4215
Conversation
This file contains 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
clalancette
reviewed
Mar 13, 2024
There was a problem hiding this comment.
Thanks for the fix.
I'm somewhat hesitant to put this in as-is. While this definitely works for Sphinx 7 and newer, it does not work for older versions of Sphinx. While that won't affect our deployment (we use Sphinx 7.2.6 currently), it could make the documentation more difficult for people to build locally. If there is a way we can discover the sphinx version and only conditionally do this for sphinx >= 7, that would make me feel better about it.
|
it seems to work with sphinx 6 at least, but i added a conditional on sphinx >=7, so even older versions will not be broken by this 👍 |
clalancette
approved these changes
Mar 13, 2024
clalancette
added
the
backport-all
mergify bot
pushed a commit
that referenced
this pull request
Mar 13, 2024
* use pathlib paths for sphinx compatibility * conditionally use pathlib if sphinx >=7 (cherry picked from commit 3ec513d)
mergify bot
pushed a commit
that referenced
this pull request
Mar 13, 2024
* use pathlib paths for sphinx compatibility * conditionally use pathlib if sphinx >=7 (cherry picked from commit 3ec513d)
clalancette
pushed a commit
that referenced
this pull request
Mar 13, 2024
…4227) * use pathlib paths for sphinx compatibility * conditionally use pathlib if sphinx >=7 (cherry picked from commit 3ec513d) Co-authored-by: Jonas Otto <[email protected]>
clalancette
pushed a commit
that referenced
this pull request
Mar 13, 2024
…4228) * use pathlib paths for sphinx compatibility * conditionally use pathlib if sphinx >=7 (cherry picked from commit 3ec513d) Co-authored-by: Jonas Otto <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
fixes this sphinx warning: