Improve docs

Cargo.toml

@@ -28,6 +28,10 @@ bevy_ecs = { version = "0.12.1", features = ["multi-threaded"] }
 bevy_tasks = "0.12.1"
 divan = "0.1.11"
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [lints]
 workspace = true
 

README.md

@@ -13,8 +13,9 @@ The control flow of the entire program is then defined by the flow of events bet
 - Structural changes to the world (such as entity despawning, component additions/removals, etc.) are mediated by events, allowing systems to hook into their occurrence.
 - _Targeted events_ enable systems to efficiently filter events based on queries.
 - Component types, event types, and systems are identified with generational indices, allowing them to be added and removed dynamically.
-- The interface to the library does not rely on Rust's type system. `evenio` should also be usable in dynamic contexts such as scripting languages or plugins.
-- A small set of dependencies and `no_std` support.
+- Execute systems in parallel with [Rayon].
+- Core of the library does not depend on Rust's type system.
+- `no_std` support.
 
 Features such as inter-system parallelism and event batching are planned but not yet implemented.
 

src/fetch.rs

@@ -297,6 +297,7 @@ impl fmt::Display for GetError {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl std::error::Error for GetError {}
 
 unsafe impl<Q> SystemParam for Fetcher<'_, Q>
@@ -461,6 +462,7 @@ impl fmt::Display for SingleError {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl std::error::Error for SingleError {}
 
 /// Iterator over entities matching the query `Q`.
@@ -578,6 +580,7 @@ unsafe impl<Q: Query> Send for Iter<'_, Q> {}
 unsafe impl<Q: Query> Sync for Iter<'_, Q> {}
 
 #[cfg(feature = "rayon")]
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 pub use rayon_impl::*;
 
 #[cfg(feature = "rayon")]
@@ -646,6 +649,7 @@ mod rayon_impl {
         }
     }
 
+    #[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
     impl<'a, Q> IntoParallelIterator for Fetcher<'a, Q>
     where
         Q: Query,
@@ -660,6 +664,7 @@ mod rayon_impl {
         }
     }
 
+    #[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
     impl<'a, Q> IntoParallelIterator for &'a Fetcher<'_, Q>
     where
         Q: ReadOnlyQuery,
@@ -674,6 +679,7 @@ mod rayon_impl {
         }
     }
 
+    #[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
     impl<'a, Q: Query> IntoParallelIterator for &'a mut Fetcher<'_, Q>
     where
         Q: Query,

src/lib.rs

@@ -2,6 +2,8 @@
 #![cfg_attr(not(any(feature = "std", test)), no_std)]
 #![warn(clippy::std_instead_of_alloc, clippy::std_instead_of_core)]
 #![allow(clippy::len_without_is_empty, clippy::let_unit_value)]
+// Run locally with `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --open`
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 extern crate alloc;
 
@@ -32,6 +34,7 @@ pub mod tutorial;
 pub mod world;
 
 #[cfg(feature = "rayon")]
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 pub use rayon;
 
 /// For macros only.

src/system.rs

@@ -733,6 +733,7 @@ impl fmt::Display for InitError {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl std::error::Error for InitError {}
 
 /// The priority of a system relative to other systems that handle the same
@@ -1196,6 +1197,7 @@ unsafe impl SystemParam for &'_ SystemInfo {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 unsafe impl<P: SystemParam> SystemParam for std::sync::Mutex<P> {
     type State = P::State;
 
@@ -1224,6 +1226,7 @@ unsafe impl<P: SystemParam> SystemParam for std::sync::Mutex<P> {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 unsafe impl<P: SystemParam> SystemParam for std::sync::RwLock<P> {
     type State = P::State;