use image paths relative to md file #45
Open
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
|
Merge please. |
|
Would be nice to include some test cases or expected inputs/outputs. |
amyreese
reviewed
Feb 3, 2025
Comment on lines
+232
to
+234
| image_path = os.path.join(os.path.dirname(self.mdinclude_path), src).replace( | ||
| "\\", "/" | ||
| ) |
There was a problem hiding this comment.
I'd like to see this using pathlib and proper separator normalization rather than string replacements.
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.
Description
we use this plugin to include readme.md files into the sphinx documentation.
In this usecase used images are referenced relative to the *.md file - currently sphinx will not be able to find those files.
With this fix sphinx will search for images relative to the md file.