Replace sphinx-rust with sphinxcontrib-rust - #151
Merged
timkpaine merged 1 commit intoSep 7, 2026
Conversation
sphinx-rust has not been released since April 2024 and pins sphinx~=7.3, which held the whole dependency set on Sphinx 7 and made current versions of pydata-sphinx-theme and sphinx-book-theme unresolvable. sphinxcontrib-rust is actively maintained and supports Sphinx 7 through 9. It is GPL-3.0 rather than MIT, so it stays confined to the opt-in rust extra, and it builds a sphinx-rustdocgen binary on install, which requires a Rust toolchain. The configuration is not a drop-in replacement, so [tool.yardang.sphinx-rust] changes shape: crates becomes a name to directory mapping, doc-dir replaces the implicit output location, and doc-formats and viewcode give way to rustdoc-fmt, visibility, strip-src and generate-mode. Pages are now generated rather than written by hand, so the Rust section of the API example links to the generated page instead of declaring directives itself.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #151 +/- ##
==========================================
+ Coverage 85.48% 86.19% +0.70%
==========================================
Files 15 16 +1
Lines 1936 2021 +85
Branches 204 209 +5
==========================================
+ Hits 1655 1742 +87
- Misses 216 217 +1
+ Partials 65 62 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
sphinx-rust has not been released since April 2024 and pins sphinx~=7.3, which held the whole dependency set on Sphinx 7 and made current versions of pydata-sphinx-theme and sphinx-book-theme unresolvable.
sphinxcontrib-rust is actively maintained and supports Sphinx 7 through 9. It is GPL-3.0 rather than MIT, so it stays confined to the opt-in rust extra, and it builds a sphinx-rustdocgen binary on install, which requires a Rust toolchain.
The configuration is not a drop-in replacement, so [tool.yardang.sphinx-rust] changes shape: crates becomes a name to directory mapping, doc-dir replaces the implicit output location, and doc-formats and viewcode give way to rustdoc-fmt, visibility, strip-src and generate-mode.
Pages are now generated rather than written by hand, so the Rust section of the API example links to the generated page instead of declaring directives itself.