Added html_root_url as specified in https://rust-lang.github.io/api-guidelines/documentation.html#c-html-root

slinkydeveloper · slinkydeveloper · commit 30367b7e54db · 2020-10-30T09:53:49.000+01:00
Signed-off-by: Francesco Guardiani &lt;francescoguard@gmail.com&gt;
diff --git a/Cargo.toml b/Cargo.toml
@@ -37,6 +37,7 @@ uuid = { version = "^0.8", features = ["v4", "wasm-bindgen"] }
 [dev-dependencies]
 rstest = "0.6"
 claim = "0.3.1"
+version-sync = "^0.9"
 
 [workspace]
 members = [
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ Note: This project is WIP under active development, hence all APIs are considere
 To get started, add the dependency to `Cargo.toml`:
 
 ```toml
+[dependencies]
 cloudevents-sdk = "0.2.0"
 ```
 
diff --git a/cloudevents-sdk-actix-web/Cargo.toml b/cloudevents-sdk-actix-web/Cargo.toml
@@ -24,4 +24,5 @@ futures = "^0.3"
 [dev-dependencies]
 url = { version = "^2.1", features = ["serde"] }
 serde_json = "^1.0"
-chrono = { version = "^0.4", features = ["serde"] }
+chrono = { version = "^0.4", features = ["serde"] }
+version-sync = "^0.9"
diff --git a/cloudevents-sdk-actix-web/src/lib.rs b/cloudevents-sdk-actix-web/src/lib.rs
@@ -41,6 +41,7 @@
 //!
 //! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
 
+#![doc(html_root_url = "https://docs.rs/cloudevents-sdk-actix-web/0.2.0")]
 #![deny(broken_intra_doc_links)]
 
 #[macro_use]
diff --git a/cloudevents-sdk-actix-web/tests/version_number.rs b/cloudevents-sdk-actix-web/tests/version_number.rs
@@ -0,0 +1,9 @@
+#[test]
+fn test_readme_deps() {
+    version_sync::assert_markdown_deps_updated!("README.md");
+}
+
+#[test]
+fn test_html_root_url() {
+    version_sync::assert_html_root_url_updated!("src/lib.rs");
+}
diff --git a/cloudevents-sdk-rdkafka/Cargo.toml b/cloudevents-sdk-rdkafka/Cargo.toml
@@ -24,3 +24,4 @@ serde_json = "^1.0"
 chrono = { version = "^0.4", features = ["serde"] }
 futures = "0.3.5"
 rdkafka = { version = "^0.24" }
+version-sync = "^0.9"
diff --git a/cloudevents-sdk-rdkafka/src/lib.rs b/cloudevents-sdk-rdkafka/src/lib.rs
@@ -48,6 +48,7 @@
 //! # }
 //! ```
 
+#![doc(html_root_url = "https://docs.rs/cloudevents-sdk-rdkafka/0.2.0")]
 #![deny(broken_intra_doc_links)]
 
 #[macro_use]
diff --git a/cloudevents-sdk-rdkafka/tests/version_number.rs b/cloudevents-sdk-rdkafka/tests/version_number.rs
@@ -0,0 +1,9 @@
+#[test]
+fn test_readme_deps() {
+    version_sync::assert_markdown_deps_updated!("README.md");
+}
+
+#[test]
+fn test_html_root_url() {
+    version_sync::assert_html_root_url_updated!("src/lib.rs");
+}
diff --git a/cloudevents-sdk-reqwest/Cargo.toml b/cloudevents-sdk-reqwest/Cargo.toml
@@ -28,4 +28,5 @@ mockito = "0.25.1"
 tokio = { version = "^0.2", features = ["full"] }
 url = { version = "^2.1" }
 serde_json = "^1.0"
-chrono = { version = "^0.4", features = ["serde"] }
+chrono = { version = "^0.4", features = ["serde"] }
+version-sync = "^0.9"
diff --git a/cloudevents-sdk-reqwest/src/lib.rs b/cloudevents-sdk-reqwest/src/lib.rs
@@ -29,6 +29,7 @@
 //!
 //! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`].
 
+#![doc(html_root_url = "https://docs.rs/cloudevents-sdk-reqwest/0.2.0")]
 #![deny(broken_intra_doc_links)]
 
 #[macro_use]
diff --git a/cloudevents-sdk-reqwest/tests/version_number.rs b/cloudevents-sdk-reqwest/tests/version_number.rs
@@ -0,0 +1,9 @@
+#[test]
+fn test_readme_deps() {
+    version_sync::assert_markdown_deps_updated!("README.md");
+}
+
+#[test]
+fn test_html_root_url() {
+    version_sync::assert_html_root_url_updated!("src/lib.rs");
+}
diff --git a/src/lib.rs b/src/lib.rs
@@ -37,6 +37,7 @@
 //! * [cloudevents-sdk-rdkafka](https://docs.rs/cloudevents-sdk-rdkafka): Integration with [rdkafka](https://fede1024.github.io/rust-rdkafka)
 //!
 
+#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.2.0")]
 #![deny(broken_intra_doc_links)]
 
 pub mod event;
diff --git a/tests/version_number.rs b/tests/version_number.rs
@@ -0,0 +1,9 @@
+#[test]
+fn test_readme_deps() {
+    version_sync::assert_markdown_deps_updated!("README.md");
+}
+
+#[test]
+fn test_html_root_url() {
+    version_sync::assert_html_root_url_updated!("src/lib.rs");
+}
