Fix relative links in reference documentation #468
Merged
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
austin-denoble
approved these changes
Mar 10, 2025
Contributor
austin-denoble
left a comment
austin-denoble
left a comment
There was a problem hiding this comment.
LGTM, thanks a bunch for getting this fixed up.
|
|
||
| if __name__ == "__main__": | ||
| if len(sys.argv) < 2: | ||
| print("Usage: python script.py input.html [output.html]") |
Contributor
There was a problem hiding this comment.
nit: Might be worth changing this to python fix-relative-links.py
| continue | ||
|
|
||
| print(f"Processing {file}") | ||
| input_path = os.path.join(root, file) |
Contributor
There was a problem hiding this comment.
We probably don't need to be defensive here, but would it make sense to check that the files being processed are html?
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.
Problem
In the rendered static site at https://sdk.pinecone.io/python, links from within the README to other markdown files in the github repo are currently broken links.
Solution
beautifulsoup4as dev dependency to enable parsing generated docs pages@privateannotations in a few places to hide clutter)Type of Change