Merge pull request #49 from topenkoff/docs-features

Docs features
hit-box · Mar 15, 2022 · 3fd47de · 3fd47de
2 parents c3eea33 + b9c5569
commit 3fd47de
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 3 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [1.51.0, stable]
+        rust: [1.54.0, stable]
     steps:
     - uses: actions/checkout@main
     - uses: actions-rs/toolchain@v1
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [1.51.0, stable, beta]
+        rust: [1.54.0, stable, beta]
         redis-version: [6]
     steps:
     - uses: actions/checkout@main

diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -21,6 +21,6 @@ thiserror = "1"
 prometheus = { version = "0.13" }
 env_logger = "0.9"
 actix_derive = "0.6"
-actix-web = "4.0.0-beta"
+actix-web = "4.0"
 tracing = "0.1"
 tracing-subscriber = "0.2"
diff --git a/hitbox-actix/Cargo.toml b/hitbox-actix/Cargo.toml
@@ -26,3 +26,7 @@ default = ["redis", "derive"]
 
 redis = ["hitbox-redis"]
 derive = ["hitbox/derive"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/hitbox-actix/src/lib.rs b/hitbox-actix/src/lib.rs
@@ -1,4 +1,5 @@
 #![warn(missing_docs)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 //! # Hitbox-Actix
 //!
 //! [![Build status](https://github.com/hit-box/hitbox/actions/workflows/CI.yml/badge.svg)](https://github.com/hit-box/hitbox/actions?query=workflow)
@@ -140,16 +141,19 @@ pub use messages::{IntoCache, QueryCache};
 pub use runtime::ActixAdapter;
 
 #[cfg(feature = "redis")]
+#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
 pub use hitbox_redis::RedisBackend;
 
 /// Default type alias with RedisBackend.
 /// You can disable it or define it manually in your code.
 #[cfg(feature = "redis")]
+#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
 pub type Cache = CacheActor<RedisBackend>;
 
 /// Prelude for hitbox_actix.
 pub mod prelude {
     #[cfg(feature = "redis")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
     pub use crate::{Cache, RedisBackend};
     pub use crate::{CacheActor, CacheBuilder, CacheError, Cacheable, IntoCache, QueryCache};
     pub use hitbox::hitbox_serializer;

diff --git a/hitbox/Cargo.toml b/hitbox/Cargo.toml
@@ -32,3 +32,7 @@ default = []
 
 derive = ["hitbox-derive", "serde_qs", "actix/macros"]
 metrics = ["prometheus", "lazy_static"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/hitbox/src/cache.rs b/hitbox/src/cache.rs
@@ -2,6 +2,7 @@
 
 use crate::CacheError;
 #[cfg(feature = "derive")]
+#[cfg_attr(docsrs, doc(cfg(feature = "derive")))]
 pub use hitbox_derive::Cacheable;
 
 /// Trait describes cache configuration per type that implements this trait.

diff --git a/hitbox/src/lib.rs b/hitbox/src/lib.rs
@@ -62,11 +62,13 @@
 //! [hitbox-actix]: https://docs.rs/hitbox_actix/
 //! [dogpile effect]: https://www.sobstel.org/blog/preventing-dogpile-effect/
 #![warn(missing_docs)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 pub mod cache;
 pub mod dev;
 pub mod error;
 #[cfg(feature = "metrics")]
+#[cfg_attr(docsrs, doc(cfg(feature = "metrics")))]
 pub mod metrics;
 pub mod response;
 pub mod runtime;

diff --git a/hitbox/src/response.rs b/hitbox/src/response.rs
@@ -5,6 +5,7 @@
 use serde::{de::DeserializeOwned, Serialize};
 
 #[cfg(feature = "derive")]
+#[cfg_attr(docsrs, doc(cfg(feature = "derive")))]
 pub use hitbox_derive::CacheableResponse;
 
 /// This trait determines which types should be cached or not.