mohr/nexosim
1
0
Fork 0
forked from ROMEO/nexosim
Code Pull Requests Activity

Add automatic feature documentation for docs.rs

Browse Source
This commit is contained in:
Serge Barral 2024-09-08 17:31:39 +02:00
parent bf7fb9b28b
commit 1c0c8ed529
3 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@ -163,3 +163,5 @@ jobs:
- name: Run cargo doc - name: Run cargo doc
run: cargo doc --no-deps --all-features --document-private-items run: cargo doc --no-deps --all-features --document-private-items
env:
RUSTDOCFLAGS: --cfg docsrs -Dwarnings

4
asynchronix/Cargo.toml
View File

@ -71,6 +71,10 @@ tonic-build = { version = "0.12" }
# `asynchronix_grpc_codegen` flag: regenerate gRPC code from .proto definitions. # `asynchronix_grpc_codegen` flag: regenerate gRPC code from .proto definitions.
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(asynchronix_loom)', 'cfg(asynchronix_grpc_codegen)'] } unexpected_cfgs = { level = "warn", check-cfg = ['cfg(asynchronix_loom)', 'cfg(asynchronix_grpc_codegen)'] }
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[[test]] [[test]]
name = "integration" name = "integration"
path = "tests/tests.rs" path = "tests/tests.rs"

2
asynchronix/src/lib.rs
View File

@ -406,6 +406,8 @@
//! * the [`time`] module discusses in particular the monotonic timestamp format //! * the [`time`] module discusses in particular the monotonic timestamp format
//! used for simulations ([`time::MonotonicTime`]). //! used for simulations ([`time::MonotonicTime`]).
#![warn(missing_docs, missing_debug_implementations, unreachable_pub)] #![warn(missing_docs, missing_debug_implementations, unreachable_pub)]
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg_hide))]
#![cfg_attr(docsrs, doc(cfg_hide(feature = "dev-hooks")))]
pub(crate) mod channel; pub(crate) mod channel;
pub(crate) mod executor; pub(crate) mod executor;