Skip to content

Replace sphinx-rust with sphinxcontrib-rust - #151

Merged
timkpaine merged 1 commit into
python-project-templates:mainfrom
Point72:tkp/sphinxcontrib-rust
Sep 7, 2026
Merged

Replace sphinx-rust with sphinxcontrib-rust#151
timkpaine merged 1 commit into
python-project-templates:mainfrom
Point72:tkp/sphinxcontrib-rust

Conversation

@timkpaine

Copy link
Copy Markdown
Member

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.

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

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.19%. Comparing base (0f5dc60) to head (88d647d).
⚠️ Report is 2 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@timkpaine
timkpaine merged commit 16aa2a5 into python-project-templates:main Sep 7, 2026
3 checks passed
@timkpaine
timkpaine deleted the tkp/sphinxcontrib-rust branch September 7, 2026 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant