Parse Rust doc comments as markdown - #152
Merged
timkpaine merged 2 commits intoSep 8, 2026
Merged
Conversation
Rust doc comments are markdown by convention, but sphinxcontrib-rust defaults to reStructuredText. That left headings such as # Arguments and # Returns rendering as page headings and fenced code blocks collapsing into literal backticked text.
sphinxcontrib-rust shells out to a sphinx-rustdocgen binary that its Python package only produces as a side effect of compiling the sdist. When uv serves a cached wheel that step never runs, the binary is absent, and the docs build fails resolving the executable. Main only passes today because its cache was cold, so install the binary directly rather than depending on a cache miss.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #152 +/- ##
=======================================
Coverage 86.19% 86.19%
=======================================
Files 16 16
Lines 2021 2021
Branches 209 209
=======================================
Hits 1742 1742
Misses 217 217
Partials 62 62 ☔ 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
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.
Rust doc comments are markdown by convention, but sphinxcontrib-rust defaults to reStructuredText. That left headings such as # Arguments and # Returns rendering as page headings and fenced code blocks collapsing into literal backticked text.
Description
Brief description of the changes in this PR.
Type of Change
Checklist
make lint)make test)