ci: generate docs (#1810)

Check docs as part of CI. This should catch link errors.
This commit is contained in:
Carl Lerche
2019-11-22 11:55:57 -08:00
committed by GitHub
parent 9b2aa14bb1
commit bf741fec35
4 changed files with 37 additions and 19 deletions
+20 -16
View File
@@ -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:
@@ -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
@@ -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
@@ -80,9 +86,7 @@ jobs:
- clippy
- test_tokio
- test_linux
# - test_features
- loom
# - test_nightly
- cross
# - minrust
- minrust
# - tsan
+15
View File
@@ -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
View File
@@ -17,7 +17,6 @@ jobs:
steps:
- template: azure-install-rust.yml
parameters:
# rust_version: stable
rust_version: ${{ parameters.rust }}
- script: cargo install cargo-hack
+2 -2
View File
@@ -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;