pw_kernel/examples/adventure/BUILD.bazel

# Copyright 2026 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.

load("@pigweed//pw_build:compatibility.bzl", "incompatible_with_mcu")
load("@pigweed//pw_build:pw_rust_docs.bzl", "pw_rust_docs")

package(default_visibility = ["//visibility:public"])

# Build the unified Rust documentation for the adventure workspace.
#
# Since some of these libraries (like stream_protocol) depend on userspace syscall APIs
# which rely on specific platform flag configurations, this target must be built using
# the host platform configuration.
#
# Build command:
#   bazelisk build --config=host //:rust_docs
pw_rust_docs(
    name = "rust_docs",
    crates = [
        "//lib/ring_buffer",
        "//lib/line_reader",
        "//lib/stream_protocol",
    ],
    rustdoc_flags = [
        "-Z",
        "unstable-options",
        "--enable-index-page",
    ],
    target_compatible_with = incompatible_with_mcu(),
)