Make sanity tests into doc tests

Author: abrown

crates/openvino-sys/src/lib.rs

@@ -1,3 +1,20 @@
+//! This crate provides low-level, unsafe, Rust bindings to OpenVINO™ using its [C API]. If you are
+//! looking to use OpenVINO™ from Rust, you likely should look at the ergonomic, safe bindings in
+//! [openvino], which depends on this crate. See the repository [README] for more information,
+//! including build instructions.
+//!
+//! [C API]: https://docs.openvinotoolkit.org/2020.1/ie_c_api/groups.html
+//! [openvino-sys]: https://crates.io/crates/openvino-sys
+//! [openvino]: https://crates.io/crates/openvino
+//! [README]: https://github.com/intel/openvino-rs/tree/main/crates/openvino-sys
+//!
+//! An example interaction with raw [openvino-sys]:
+//! ```
+//! # use std::ffi::CStr;
+//! openvino_sys::library::load().expect("to have an OpenVINO library available");
+//! let version = unsafe { CStr::from_ptr(openvino_sys::ie_c_api_version().api_version) };
+//! assert!(version.to_string_lossy().starts_with("2.1"));
+//! ```
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
@@ -38,16 +55,3 @@ pub mod library {
         }
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use std::ffi::CStr;
-
-    #[test]
-    fn check_version() {
-        load().expect("to have an OpenVINO library available");
-        let version = unsafe { CStr::from_ptr(ie_c_api_version().api_version) };
-        assert!(version.to_string_lossy().starts_with("2.1"));
-    }
-}

crates/openvino/src/core.rs

@@ -105,13 +105,3 @@ impl Core {
         Ok(ExecutableNetwork { instance })
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn construct_core() {
-        let _ = Core::new(None).unwrap();
-    }
-}

crates/openvino/src/lib.rs

@@ -1,3 +1,19 @@
+//! The [openvino] crate provides high-level, ergonomic, safe Rust bindings to OpenVINO. See the
+//! repository [README] for more information, such as build instructions.
+//!
+//! [openvino]: https://crates.io/crates/openvino
+//! [README]: https://github.com/intel/openvino-rs
+//!
+//! Check the loaded version of OpenVINO:
+//! ```
+//! assert!(openvino::version().starts_with("2.1"))
+//! ```
+//!
+//! Most interaction with OpenVINO begins with instantiating a [Core]:
+//! ```
+//! let _ = openvino::Core::new(None).expect("to instantiate the OpenVINO library");
+//! ```
+
 mod blob;
 mod core;
 mod error;
@@ -29,13 +45,3 @@ pub fn version() -> String {
     unsafe { openvino_sys::ie_version_free(&mut ie_version as *mut openvino_sys::ie_version_t) };
     str_version
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn check_version() {
-        assert!(version().starts_with("2.1"),)
-    }
-}