diff options
| author | Carl Lerche <me@carllerche.com> | 2019-11-22 11:55:57 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-22 11:55:57 -0800 |
| commit | bf741fec359736d465fa588d8feea1a48e19c055 (patch) | |
| tree | ead735f107863ee14750d9cc94e9abdf533e38c7 | |
| parent | 9b2aa14bb185f552f0842319e7fbbfe0bd9b3dc6 (diff) | |
ci: generate docs (#1810)
Check docs as part of CI. This should catch link errors.
| -rw-r--r-- | azure-pipelines.yml | 36 | ||||
| -rw-r--r-- | ci/azure-check-docs.yml | 15 | ||||
| -rw-r--r-- | ci/azure-test-stable.yml | 1 | ||||
| -rw-r--r-- | tokio-test/src/io.rs | 4 |
4 files changed, 37 insertions, 19 deletions
diff --git a/azure-pipelines.yml b/azure-pipelines.yml index ebd27eca..d660b165 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -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 diff --git a/ci/azure-check-docs.yml b/ci/azure-check-docs.yml new file mode 100644 index 00000000..6f94f339 --- /dev/null +++ b/ci/azure-check-docs.yml @@ -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 + diff --git a/ci/azure-test-stable.yml b/ci/azure-test-stable.yml index 4e5c571b..e33b6bbc 100644 --- a/ci/azure-test-stable.yml +++ b/ci/azure-test-stable.yml @@ -17,7 +17,6 @@ jobs: steps: - template: azure-install-rust.yml parameters: - # rust_version: stable rust_version: ${{ parameters.rust }} - script: cargo install cargo-hack diff --git a/tokio-test/src/io.rs b/tokio-test/src/io.rs index e6a243a1..9a3dbe04 100644 --- a/tokio-test/src/io.rs +++ b/tokio-test/src/io.rs @@ -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; |