(MAINT) Separately generate and test documentation #1203
Merged
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
Prior to this change, invoking `cargo test` for library crates without specifically choosing a test subset (unit, integration, etc) would always run the documentation tests. Documentation tests are particularly slow because Rust compiles a binary for every codeblock in your documentation. This is the slowest part of the rust tests when working on a library with extensive examples. This change adds the `doctest` setting to the crate manifests as `false` to disable documentation tests by default. These tests can still be invoked by passing the `--doc` flag to `cargo test`. Future changes will provide simplified access to generating and testing the docs from the build script, as well as validating documentation in CI.
This change updates the build helpers module to enable separately generating documentation for Rust crates and testing the examples in that documentation. It also adds a new workflow job for generating and testing documentation separately from the rest of the build and test scripts. While these jobs failing won't prevent the continued unit/integration/acceptance tests, it will still fail the build. This should help ensure that any examples in our documentation remain valid. It _doesn't_ test to ensure that public APIs are documented, only that the documentation that exists is minimally valid.
michaeltlombardi
force-pushed
the
maint/main/separate-testing
branch
from
1681eb4 to
1fa3d71
Compare
SteveL-MSFT
approved these changes
Oct 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Summary
This change:
doctestsetting to the crate manifests asfalseto disable documentation tests by default. These tests can still be invoked by passing the--docflag tocargo test.This change should help ensure that any examples in our documentation remain valid. It doesn't test to ensure that public APIs are documented, only that the documentation that exists is minimally valid.
PR Context
Prior to this change, invoking
cargo testfor library crates without specifically choosing a test subset (unit, integration, etc) would always run the documentation tests.Documentation tests are particularly slow because Rust compiles a binary for every codeblock in your documentation. This is the slowest part of the rust tests when working on a library with extensive examples.