Generate reference documentation at publish-time and the JSON schema at release-time #16969
+41
−11,609
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
zanieb
temporarily deployed
to
uv-test-registries
GitHub Actions
Inactive
zanieb
had a problem deploying
to
uv-test-publish
GitHub Actions
Error
zanieb
had a problem deploying
to
uv-test-registries
GitHub Actions
Error
zanieb
temporarily deployed
to
uv-test-registries
GitHub Actions
Inactive
zanieb
temporarily deployed
to
uv-test-publish
GitHub Actions
Inactive
CodSpeed Performance ReportMerging #16969 will not alter performanceComparing Summary
|
zanieb
commented
Dec 3, 2025
| run: cargo dev generate-all --mode check | ||
| run: cargo dev generate-all --mode dry-run | ||
| - name: "Check sysconfig mappings" | ||
| run: cargo dev generate-sysconfig-metadata --mode check |
Member
Author
There was a problem hiding this comment.
We still retain / commit the sysconfig metadata
Member
|
It would be great to have a way to check the generated documentation - we had incorrect rendering before - unfortunately, having the files added to git didn't help with that really. |
konstin
approved these changes
Dec 8, 2025
Member
Author
|
Yeah I think if we're uncertain about the rendering we'll just need to run mkdocs locally anyway, unless we add preview environments for documentation. |
zanieb
temporarily deployed
to
uv-test-registries
GitHub Actions
Inactive
zanieb
temporarily deployed
to
uv-test-publish
GitHub Actions
Inactive
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.
It'd be nice to avoid churn for contributors. This is a pretty frequent cause of CI failures and I don't think we really need to have the reference documentation committed.