From f45c83c851c2349374aa4e4dfaf3e6558e1afdd1 Mon Sep 17 00:00:00 2001 From: Toshiki Teramura Date: Sun, 25 Sep 2022 19:29:16 +0900 Subject: [PATCH 1/3] Do not allow rustdoc::broken_intra_doc_links --- lax/src/lib.rs | 2 ++ ndarray-linalg/src/lib.rs | 1 + 2 files changed, 3 insertions(+) diff --git a/lax/src/lib.rs b/lax/src/lib.rs index b5f9f16c..adefcfea 100644 --- a/lax/src/lib.rs +++ b/lax/src/lib.rs @@ -71,6 +71,8 @@ //! for solving least square problem by SVD //! +#![deny(rustdoc::broken_intra_doc_links)] + #[cfg(any(feature = "intel-mkl-system", feature = "intel-mkl-static"))] extern crate intel_mkl_src as _src; diff --git a/ndarray-linalg/src/lib.rs b/ndarray-linalg/src/lib.rs index 8a8088c8..a957e20b 100644 --- a/ndarray-linalg/src/lib.rs +++ b/ndarray-linalg/src/lib.rs @@ -44,6 +44,7 @@ clippy::type_complexity, clippy::ptr_arg )] +#![deny(rustdoc::broken_intra_doc_links)] #[macro_use] extern crate ndarray; From 6b984de5d37c86203188c3f22d8284e0a0cff5df Mon Sep 17 00:00:00 2001 From: Toshiki Teramura Date: Sun, 25 Sep 2022 19:31:35 +0900 Subject: [PATCH 2/3] Add cargo-doc job --- .github/workflows/rust.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 199b9cad..9cd3919b 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -25,6 +25,15 @@ jobs: command: check args: --all-targets + check-doc: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v1 + - uses: actions-rs/cargo@v1 + with: + command: doc + args: --no-deps + clippy: runs-on: ubuntu-22.04 steps: From 3f7349044549947c3c4f07226df834c98d74db66 Mon Sep 17 00:00:00 2001 From: Toshiki Teramura Date: Sun, 25 Sep 2022 19:39:46 +0900 Subject: [PATCH 3/3] Update document --- lax/src/lib.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lax/src/lib.rs b/lax/src/lib.rs index adefcfea..ede5b4d0 100644 --- a/lax/src/lib.rs +++ b/lax/src/lib.rs @@ -59,7 +59,8 @@ //! there are several types of eigenvalue problem API //! //! - [eig] module for eigenvalue problem for general matrix. -//! - [Eigh_] trait provides methods for eigenvalue problem for symmetric/hermite matrix. +//! - [eigh] module for eigenvalue problem for symmetric/hermite matrix. +//! - [eigh_generalized] module for generalized eigenvalue problem for symmetric/hermite matrix. //! //! Singular Value Decomposition //! -----------------------------