Use #[cfg(doc)] instead of docs.rs-specific cfg flag
#287
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
josephlr
requested changes
Aug 2, 2021
Cargo.toml
Outdated
Comment on lines
45
to
47
| [package.metadata.docs.rs] | ||
| rustdoc-args = ["--cfg", "docsrs"] | ||
|
|
There was a problem hiding this comment.
We still need to pass --cfg docsrs when building for docs.rs. This is so we can enable the doc_cfg feature, allowing us to note which features are required for which functions. For example:
With docsrs:
Without docsrs:
There was a problem hiding this comment.
I just decided to add a doc_cfg nightly-only feature to handle this. Now running cargo doc just does the right thing by default.
Comment on lines
+68
to
+72
| - name: "Run cargo doc" | ||
| uses: actions-rs/cargo@v1 | ||
| with: | ||
| command: doc | ||
|
|
There was a problem hiding this comment.
I think we should do 3 runs of cargo doc here:
cargo doc- default flags, on nightly
RUSTDOCFLAGS="--cfg docsrs" cargo doc- flags docs.rs will use, on nightly
cargo +stable doc --no-default-features --features=external_asm,instructions- make sure we can build the docs with the stable compiler
There was a problem hiding this comment.
I decided to just have (1) and (3), now that we don't have the docsrs stuff.
josephlr
force-pushed
the
fix-cargo-doc-warnings
branch
2 times, most recently
from
58202ef to
e1e5f50
Compare
josephlr
approved these changes
Aug 14, 2021
josephlr
force-pushed
the
fix-cargo-doc-warnings
branch
4 times, most recently
from
33b3c2c to
a80a0cf
Compare
josephlr
force-pushed
the
fix-cargo-doc-warnings
branch
2 times, most recently
from
4048bab to
b3db805
Compare
The documentation can also be built locally using `cargo doc --open`. Doc links should be working there as well.
Signed-off-by: Joe Richey <joerichey@google.com>
Signed-off-by: Joe Richey <joerichey@google.com>
josephlr
force-pushed
the
fix-cargo-doc-warnings
branch
from
b3db805 to
5354b02
Compare
|
Great, thanks a lot for your improvements! |
Merged
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.
The documentation can also be built locally using
cargo doc --open. Doc links should be working there as well.