This module provides a single place for all aspects, rules, and macros that are meant to have stardoc generated documentation.
Rules
rust_doc
Generates code documentation.
Example: Suppose you have the following directory structure for a Rust library crate:
[workspace]/
WORKSPACE
hello_lib/
BUILD
src/
lib.rs
To build rustdoc
documentation for the hello_lib
crate, define a rust_doc
rule that depends on the the hello_lib
rust_library
target:
package(default_visibility = ["//visibility:public"])
load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
rust_library(
name = "hello_lib",
srcs = ["src/lib.rs"],
)
rust_doc(
name = "hello_lib_doc",
crate = ":hello_lib",
)
Running bazel build //hello_lib:hello_lib_doc
will build a zip file containing the documentation for the hello_lib
library crate generated by rustdoc
.
name
A unique name for this target.
crate
The label of the target to generate code documentation for.
rust_doc
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets.
dep
deprecated: use crate
html_after_content
File to add in <body>
, after content.
html_before_content
File to add in <body>
, before content.
html_in_header
File to add to <head>
.
markdown_css
CSS files to include via <link>
in a rendered Markdown file.
rust_doc_test
Runs Rust documentation tests.
Example:
Suppose you have the following directory structure for a Rust library crate:
[workspace]/
WORKSPACE
hello_lib/
BUILD
src/
lib.rs
To run documentation tests for the hello_lib
crate, define a rust_doc_test
target that depends on the hello_lib
rust_library
target:
package(default_visibility = ["//visibility:public"])
load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc_test")
rust_library(
name = "hello_lib",
srcs = ["src/lib.rs"],
)
rust_doc_test(
name = "hello_lib_doc_test",
crate = ":hello_lib",
)
Running bazel test //hello_lib:hello_lib_doc_test
will run all documentation tests for the hello_lib
library crate.
name
A unique name for this target.
crate
The label of the target to generate code documentation for. rust_doc_test
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets.
dep
deprecated: use crate