CARGO_PKG_README related fixes (#75)

sophus-vision · Feb 16, 2025 · 1217e14 · 1217e14
1 parent 27f588d
commit 1217e14
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/crates/sophus_autodiff/Cargo.toml b/crates/sophus_autodiff/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 description = "sophus - geometry for robotics and computer vision"
 name = "sophus_autodiff"
-readme = "../README.md"
+readme = "README.md"
 
 edition.workspace = true
 include.workspace = true

diff --git a/crates/sophus_autodiff/src/lib.rs b/crates/sophus_autodiff/src/lib.rs
@@ -2,9 +2,13 @@
 #![deny(missing_docs)]
 #![no_std]
 #![allow(clippy::needless_range_loop)]
-#![doc = include_str!(concat!("./", std::env!("CARGO_PKG_README")))]
+#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
 #![cfg_attr(nightly, feature(doc_auto_cfg))]
 
+#[doc = include_str!(concat!("../",  core::env!("CARGO_PKG_README")))]
+#[cfg(doctest)]
+pub struct ReadmeDoctests;
+
 #[cfg(feature = "std")]
 extern crate std;
 

diff --git a/crates/sophus_geo/Cargo.toml b/crates/sophus_geo/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 description = "sophus - geometry for robotics and computer vision"
 name = "sophus_geo"
-readme = "../README.md"
+readme = "README.md"
 
 edition.workspace = true
 include.workspace = true

diff --git a/crates/sophus_geo/src/lib.rs b/crates/sophus_geo/src/lib.rs
@@ -2,13 +2,13 @@
 #![deny(missing_docs)]
 #![no_std]
 #![allow(clippy::needless_range_loop)]
-#![doc = include_str!(concat!("./", std::env!("CARGO_PKG_README")))]
+#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
 #![cfg_attr(nightly, feature(doc_auto_cfg))]
 
 #[cfg(feature = "std")]
 extern crate std;
 
-#[doc = include_str!(concat!("./",  core::env!("CARGO_PKG_README")))]
+#[doc = include_str!(concat!("../",  core::env!("CARGO_PKG_README")))]
 #[cfg(doctest)]
 pub struct ReadmeDoctests;