From 6df26a3be3a2eb28496c26a837dbb1b789b93d7e Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Tue, 21 Jan 2025 06:45:56 -0500 Subject: [PATCH] Fix broken intra-doc link (#3186) --- .github/workflows/CI.yml | 12 ++++++++---- axum-extra/CHANGELOG.md | 4 +++- axum-extra/Cargo.toml | 6 ++++++ 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 54737b66..b19b3aa7 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -34,10 +34,14 @@ jobs: - uses: Swatinem/rust-cache@v2 with: save-if: ${{ github.ref == 'refs/heads/main' }} - - name: cargo doc - env: - RUSTDOCFLAGS: "-D rustdoc::all -A rustdoc::private-doc-tests" - run: cargo doc --all-features --no-deps + - name: cargo doc -p axum-core + run: cargo doc --package axum-core --all-features --no-deps + - name: cargo doc -p axum + run: cargo doc --package axum --all-features --no-deps + - name: cargo doc -p axum-extra + run: cargo doc --package axum-extra --all-features --no-deps + env: + RUSTDOCFLAGS: "-D rustdoc::all -A rustdoc::private-doc-tests" cargo-hack: runs-on: ubuntu-24.04 diff --git a/axum-extra/CHANGELOG.md b/axum-extra/CHANGELOG.md index 209cdca7..ba04d6dd 100644 --- a/axum-extra/CHANGELOG.md +++ b/axum-extra/CHANGELOG.md @@ -10,11 +10,13 @@ and this project adheres to [Semantic Versioning]. - **breaking:** Remove unused `async-stream` feature, which was accidentally introduced as an implicit feature through an optional dependency which was no longer being used ([#3145]) -- **change:** Make the `status` function of rejections a `const` function, such +- **fixed:** Fix a broken link in the documentation of `ErasedJson` ([#3186]) +- **changed:** Make the `status` function of rejections a `const` function, such as `FormRejection`, `QueryRejection` and `MultipartRejection` ([#3168]) [#3145]: https://github.com/tokio-rs/axum/pull/3145 [#3168]: https://github.com/tokio-rs/axum/pull/3168 +[#3186]: https://github.com/tokio-rs/axum/pull/3186 # 0.10.0 diff --git a/axum-extra/Cargo.toml b/axum-extra/Cargo.toml index 07eaa4a3..8ecf0e51 100644 --- a/axum-extra/Cargo.toml +++ b/axum-extra/Cargo.toml @@ -41,6 +41,12 @@ tracing = ["axum-core/tracing", "axum/tracing"] typed-header = ["dep:headers"] typed-routing = ["dep:axum-macros", "dep:percent-encoding", "dep:serde_html_form", "dep:form_urlencoded"] +# Enabled by docs.rs because it uses all-features +__private_docs = [ + # Required for the ErasedJson docs to be able to link to axum::Json + "axum/json", +] + [dependencies] axum = { path = "../axum", version = "0.8.0", default-features = false, features = ["original-uri"] } axum-core = { path = "../axum-core", version = "0.5.0" }