Fix broken source links in documentation #1934
Open
+2
−0
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
The documentation source links were pointing to `src/tokenizers/...` which doesn't exist. The Python source files are located at `bindings/python/py_src/tokenizers/...`. Add `version_tag_suffix` parameter to documentation build workflows to generate correct GitHub source links. Fixes huggingface#1910
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.
What does this PR do?
Fixes broken GitHub source links in the API documentation (e.g., Visualizer page).
The doc-builder was generating links to
src/tokenizers/...but the Python source files are located atbindings/python/py_src/tokenizers/....Example broken link:
https://github.com/huggingface/tokenizers/blob/v0.20.3/src/tokenizers/tools/visualizer.py→ 404Correct path:
https://github.com/huggingface/tokenizers/blob/main/bindings/python/py_src/tokenizers/tools/visualizer.pyFix
Added
version_tag_suffix: bindings/python/py_src/parameter to documentation build workflows to generate correct source links.Fixes #1910