Skip to content

Commit 4b2837a

Browse files
committed
chore(ci): Ensure intradoc links are valid
1 parent 04a4081 commit 4b2837a

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

.github/workflows/main.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,9 @@ jobs:
150150
mkdir mdbook
151151
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.5/mdbook-v0.4.5-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
152152
echo `pwd`/mdbook >> $GITHUB_PATH
153-
- run: cargo doc --no-deps
153+
- run: cargo doc --document-private-items --no-deps
154+
env:
155+
RUSTDOCFLAGS: -D warnings
154156
- run: cd src/doc && mdbook build --dest-dir ../../target/doc
155157
- run: |
156158
cd src/doc

src/cargo/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
// Due to some of the default clippy lints being somewhat subjective and not
66
// necessarily an improvement, we prefer to not use them at this time.
77
#![allow(clippy::all)]
8+
#![allow(rustdoc::private_intra_doc_links)]
89

910
//! # Cargo as a library
1011
//!

src/cargo/ops/fix.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ pub fn fix_get_proxy_lock_addr() -> Option<String> {
348348
/// If there are warnings or errors, this does not return,
349349
/// and the process exits with the corresponding `rustc` exit code.
350350
///
351-
/// See [`fix_proxy_lock_addr`]
351+
/// See [`fix_get_proxy_lock_addr`]
352352
pub fn fix_exec_rustc(config: &Config, lock_addr: &str) -> CargoResult<()> {
353353
let args = FixArgs::get()?;
354354
trace!("cargo-fix as rustc got file {:?}", args.file);

0 commit comments

Comments
 (0)