feat: add GitHub Links Sphinx extension #26
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
- Automatically converts GitHub issue references to clickable links in changelog files - Supports patterns like (#123) and (owner/repo#456) - Configurable URL templates, target repos, and link behavior - Only processes changelog files (changelog, release, history, news) - Includes comprehensive configuration validation - Thread-safe with parallel_read_safe and parallel_write_safe support
- 45+ test cases covering pattern matching, URL generation, and Sphinx integration - Tests for valid/invalid GitHub reference patterns (#123, owner/repo#456) - Configuration validation tests for repository formats - Changelog file detection and link creation logic - Integration tests with mocked Sphinx components - Covers new tab behavior, custom URL templates, and error handling Tests belong with the extension implementation in this PR.
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.
🔗 GitHub Links Extension
Add new Sphinx extension that automatically converts GitHub issue/PR references into clickable links in changelog files.
Features
Usage
Testing (45+ tests included)
Dependencies
Thread-safe with parallel_read_safe and parallel_write_safe support.