From d38094097aec59158b7ed4c0cbf16d7fb58fecd7 Mon Sep 17 00:00:00 2001 From: Simonas Kazlauskas Date: Sun, 28 Jan 2024 16:36:55 +0200 Subject: [PATCH] ci doc building --- .github/workflows/test.yml | 9 +++++++++ tracing-tracy/Cargo.toml | 1 + tracing-tracy/src/config.rs | 2 +- tracy-client-sys/Cargo.toml | 1 + tracy-client/Cargo.toml | 1 + 5 files changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f55ff95..5303fbe 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -30,3 +30,12 @@ jobs: - run: cargo test ${{ matrix.flags }} -- --nocapture env: TRACY_NO_INVARIANT_CHECK: 1 + doc: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - run: rustup install nightly --profile=minimal + - run: rustup default nightly + - run: cargo rustdoc --all-features -p tracy-client-sys -Zunstable-options --config 'build.rustdocflags=["--cfg", "tracy_client_sys_docs", "-D", "rustdoc::broken_intra_doc_links"]' + - run: cargo rustdoc --all-features -p tracy-client -Zunstable-options --config 'build.rustdocflags=["--cfg", "tracy_client_docs", "-D", "rustdoc::broken_intra_doc_links"]' + - run: cargo rustdoc --all-features -p tracing-tracy -Zunstable-options --config 'build.rustdocflags=["--cfg", "tracing_tracy_docs", "-D", "rustdoc::broken_intra_doc_links"]' diff --git a/tracing-tracy/Cargo.toml b/tracing-tracy/Cargo.toml index 5f89450..2f7a782 100644 --- a/tracing-tracy/Cargo.toml +++ b/tracing-tracy/Cargo.toml @@ -52,3 +52,4 @@ flush-on-exit = ["client/flush-on-exit"] [package.metadata.docs.rs] rustdoc-args = ["--cfg", "tracing_tracy_docs"] +all-features = true diff --git a/tracing-tracy/src/config.rs b/tracing-tracy/src/config.rs index 0317272..b96e6a7 100644 --- a/tracing-tracy/src/config.rs +++ b/tracing-tracy/src/config.rs @@ -71,7 +71,7 @@ pub trait Config { /// Apply handling for errors detected by the [`TracyLayer`](super::TracyLayer). /// /// Fundamentally the way the tracing crate and the Tracy profiler work are somewhat - /// incompatible in certain ways. For instance, a [`tracing::Span`] can be created on one + /// incompatible in certain ways. For instance, a `tracing::Span` can be created on one /// thread and moved to another, where it is cleaned up. Tracy on the other hand expects that /// its eqvivalent concept of zone remains entirely within a thread. /// diff --git a/tracy-client-sys/Cargo.toml b/tracy-client-sys/Cargo.toml index 355f1ca..9a12ef3 100644 --- a/tracy-client-sys/Cargo.toml +++ b/tracy-client-sys/Cargo.toml @@ -46,4 +46,5 @@ callstack-inlines = [] flush-on-exit = [] [package.metadata.docs.rs] +all-features = true rustdoc-args = ["--cfg", "tracy_client_sys_docs"] diff --git a/tracy-client/Cargo.toml b/tracy-client/Cargo.toml index 4a6ad9e..209e772 100644 --- a/tracy-client/Cargo.toml +++ b/tracy-client/Cargo.toml @@ -65,3 +65,4 @@ flush-on-exit = ["sys/flush-on-exit"] [package.metadata.docs.rs] rustdoc-args = ["--cfg", "tracy_client_docs"] +all-features = true