Build-test documentation in the CI and fix/improve broken links #455
Conversation
This file contains 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
MarijnS95
commented
Apr 7, 2022
Codecov Report
@@ Coverage Diff @@
## master #455 +/- ##
==========================================
+ Coverage 80.25% 80.29% +0.03%
==========================================
Files 73 73
Lines 8353 8353
==========================================
+ Hits 6704 6707 +3
+ Misses 1649 1646 -3 |
loewenheim
approved these changes
Apr 7, 2022
MarijnS95
force-pushed
the
ci-doc
branch
2 times, most recently
from
d67395b
to
6bc37c5
Compare
Some intradoc links were broken because their crates are only available as `dev-dependencies`, while others unnecessarily had a forced link to `docs.rs` which could also be an intradoc link (in turn pointing to locally built documentation if not building on docs.rs). To make sure these links don't break again over time, build-test the documentation in the CI while disallowing any warnings which includes broken links.
flub
approved these changes
Apr 8, 2022
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.
Some intradoc links were broken because their crates are only available as
dev-dependencies, while others unnecessarily had a forced link todocs.rswhich could also be an intradoc link (in turn pointing to locally built documentation if not building on docs.rs).To make sure these links don't break again over time, build-test the documentation in the CI while disallowing any warnings which includes broken links.