Skip to content

Commit

Permalink
ci: generate docs (tokio-rs#1810)
Browse files Browse the repository at this point in the history
Check docs as part of CI. This should catch link errors.
  • Loading branch information
carllerche authored Nov 22, 2019
1 parent 9b2aa14 commit bf741fe
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 19 deletions.
36 changes: 20 additions & 16 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,6 @@ variables:
RUSTFLAGS: -Dwarnings

jobs:
# Check formatting
- template: ci/azure-rustfmt.yml
parameters:
rust: stable
name: rustfmt

# Apply clippy lints to all crates
- template: ci/azure-clippy.yml
parameters:
rust: stable
name: clippy

# Test top level crate
- template: ci/azure-test-stable.yml
parameters:
Expand All @@ -28,7 +16,7 @@ jobs:
- tokio
- tests-integration

# Test crates that are NOT platform specific
# Test sub crates
- template: ci/azure-test-stable.yml
parameters:
name: test_linux
Expand Down Expand Up @@ -67,6 +55,24 @@ jobs:
name: minrust
rust_version: 1.39.0

# Check formatting
- template: ci/azure-rustfmt.yml
parameters:
rust: stable
name: rustfmt

# Apply clippy lints to all crates
- template: ci/azure-clippy.yml
parameters:
rust: stable
name: clippy

# Check doc generation
- template: ci/azure-check-docs.yml
parameters:
rust: nightly-2019-11-16
name: docs

# - template: ci/azure-tsan.yml
# parameters:
# name: tsan
Expand All @@ -80,9 +86,7 @@ jobs:
- clippy
- test_tokio
- test_linux
# - test_features
- loom
# - test_nightly
- cross
# - minrust
- minrust
# - tsan
15 changes: 15 additions & 0 deletions ci/azure-check-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
jobs:
# Check docs
- job: ${{ parameters.name }}
displayName: Check docs
pool:
vmImage: ubuntu-16.04
steps:
- template: azure-install-rust.yml
parameters:
rust_version: ${{ parameters.rust }}

- script: |
RUSTDOCFLAGS="--cfg docsrs" cargo doc --lib --no-deps --all-features
displayName: Check docs
1 change: 0 additions & 1 deletion ci/azure-test-stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ jobs:
steps:
- template: azure-install-rust.yml
parameters:
# rust_version: stable
rust_version: ${{ parameters.rust }}

- script: cargo install cargo-hack
Expand Down
4 changes: 2 additions & 2 deletions tokio-test/src/io.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
//! Attempting to write data that the mock isn't expected will result in a
//! panic.
//!
//! [`AsyncRead`]: tokio_io::AsyncRead
//! [`AsyncWrite`]: tokio_io::AsyncWrite
//! [`AsyncRead`]: tokio::io::AsyncRead
//! [`AsyncWrite`]: tokio::io::AsyncWrite
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::sync::mpsc;
Expand Down

0 comments on commit bf741fe

Please sign in to comment.