🎨 mark relative files correctly, remove relative directory links in sphinx#14
Draft
🎨 mark relative files correctly, remove relative directory links in sphinx#14
Conversation
- directory links cannot be meaningfully resolved - relative files will be available for download - ./ denotes a relative file path So file links in GitHub or VSCode still work and it's rendered better in the documenation now
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Figure out importing markdowns from above the
conf.pydirectoryIn
docs/developing.md, changed the:relative-docs:path in the{include}directive from an external reference to a local one (./) for better compatibility and maintainability.