Skip to content

Commit 10ae296

Browse files
authored
Merge pull request #342 from rust-ndarray/cargo-doc-test
Check broken intra document link on CI
2 parents f672b07 + 3f73490 commit 10ae296

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

.github/workflows/rust.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ jobs:
2525
command: check
2626
args: --all-targets
2727

28+
check-doc:
29+
runs-on: ubuntu-22.04
30+
steps:
31+
- uses: actions/checkout@v1
32+
- uses: actions-rs/cargo@v1
33+
with:
34+
command: doc
35+
args: --no-deps
36+
2837
clippy:
2938
runs-on: ubuntu-22.04
3039
steps:

lax/src/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@
5959
//! there are several types of eigenvalue problem API
6060
//!
6161
//! - [eig] module for eigenvalue problem for general matrix.
62-
//! - [Eigh_] trait provides methods for eigenvalue problem for symmetric/hermite matrix.
62+
//! - [eigh] module for eigenvalue problem for symmetric/hermite matrix.
63+
//! - [eigh_generalized] module for generalized eigenvalue problem for symmetric/hermite matrix.
6364
//!
6465
//! Singular Value Decomposition
6566
//! -----------------------------
@@ -71,6 +72,8 @@
7172
//! for solving least square problem by SVD
7273
//!
7374
75+
#![deny(rustdoc::broken_intra_doc_links)]
76+
7477
#[cfg(any(feature = "intel-mkl-system", feature = "intel-mkl-static"))]
7578
extern crate intel_mkl_src as _src;
7679

ndarray-linalg/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
clippy::type_complexity,
4545
clippy::ptr_arg
4646
)]
47+
#![deny(rustdoc::broken_intra_doc_links)]
4748

4849
#[macro_use]
4950
extern crate ndarray;

0 commit comments

Comments
 (0)