Fix Sphinx extension relative image path for out of source builds #3513
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
e08fc84 to
3537b09
Compare
|
Hi @clauniel, thanks so much for the contribution! It looks like the CI is flagging a lint error, you can resolve it locally with |
The use of `relative_to` causes a failure when building Sphinx documentation using an out of source build because it cannot create a relative path by walking up through parent directories prior to the `walk_up` option available in Python 3.12
3537b09 to
0b29343
Compare
|
Thanks for pointing that out, I missed the poetry environment activation. |
danyeaw
approved these changes
Sep 30, 2024
|
@all-contributors please add @clauniel for code |
|
I've put up a pull request to add @clauniel! 🎉 |
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.
The use of
relative_tocauses a failure when building Sphinx documentation using an out of source build because it cannot create a relative path by walking up through parent directories prior to thewalk_upoption available in Python 3.12PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Failure to include generated images when using out of source Sphinx builds.
What is the new behavior?
Out of source Sphinx builds are supported.
Does this PR introduce a breaking change?
Other information