docs: document full API on docs.rs and guard the build in CI#236
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
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.
docs.rs builds a crate with its default features only, which left the NFC transport out of the published documentation. This adds docs.rs metadata so the NFC transport is documented through the pcsc backend. libnfc is not available in the docs.rs build environment, so the libnfc backend is intentionally left out to keep the build green.
It also adds a CI job that builds the documentation the same way docs.rs does, inside the same container image. A broken docs build now fails a pull request instead of only showing up as a red badge after release.