Avoid RemovedInSphinx80Warning in path-manipulation code.
#977
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
In recent versions of Sphinx, code that treats Sphinx application paths such as `Sphinx.confdir` and `Sphinx.doctreedir` as strings emits the warning "Sphinx 8 will drop support for representing paths as strings". This commit updates path-manipulation code to use functions in the `os.path` module, which accept path-like objects as well as strings. This fixes issue breathe-doc#974.
simonspa
approved these changes
Apr 18, 2024
tomasbw
approved these changes
May 16, 2024
# Conflicts: # breathe/project.py
|
@AA-Turner Thanks for merging this and #976: much appreciated. |
|
No worries! Per #990 (comment) I'm happy to review other PRs if you have them, but I'm unlikey to be writing much (any) new stuff for breathe myself. A |
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.
In recent versions of Sphinx, code that treats Sphinx application paths such as
Sphinx.confdirandSphinx.doctreediras strings emits the warning "Sphinx 8 will drop support for representing paths as strings".This commit updates path-manipulation code to use functions in the
os.pathmodule, which accept path-like objects as well as strings.RemovedInSphinx80WarninginProjectInfoFactory.__init__#974.Note that you will need pull request #976 in order for tests to pass, due to issue #975.