Added docs for rust bzlmod extensions. (#3336)

Author: UebelAndre

docs/BUILD.bazel

@@ -68,6 +68,14 @@ stardoc(
     deps = [":all_docs"],
 )
 
+stardoc(
+    name = "rust_bzlmod",
+    out = "src/rust_bzlmod.md",
+    input = "@rules_rust//rust:extensions.bzl",
+    table_of_contents_template = "@stardoc//stardoc:templates/markdown_tables/table_of_contents.vm",
+    deps = [":all_docs"],
+)
+
 stardoc(
     name = "rust_unpretty",
     out = "src/rust_unpretty.md",
@@ -178,7 +186,7 @@ stardoc(
 
 stardoc(
     name = "crate_universe_workspace",
-    out = "src/crate_universe.md",
+    out = "src/crate_universe_workspace.md",
     input = "@rules_rust//crate_universe:defs.bzl",
     deps = [":all_docs"],
 )
@@ -275,6 +283,7 @@ mdbook(
         ":rust",
         ":rust_analyzer",
         ":rust_bindgen",
+        ":rust_bzlmod",
         ":rust_clippy",
         ":rust_doc",
         ":rust_fmt",

docs/src/SUMMARY.md

@@ -16,10 +16,11 @@
     - [Rust Settings](./rust_settings.md)
     - [Cargo Settings](./cargo_settings.md)
 - [Toolchains](./rust_toolchains.md)
+- [Bzlmod](./rust_bzlmod.md)
 - [Repositories](./rust_repositories.md)
 - [External Crates](./external_crates.md)
     - [crate_universe (bzlmod)](crate_universe_bzlmod.md)
-    - [crate_universe (WORKSPACE)](crate_universe.md)
+    - [crate_universe (WORKSPACE)](crate_universe_workspace.md)
 - [Upstream Tooling](./upstream_tooling.md)
 - [Extensions](./extensions.md)
     - [bindgen](./rust_bindgen.md)

rust/extensions.bzl

@@ -183,10 +183,12 @@ _RUST_REPOSITORY_SET_TAG_ATTRS = {
 } | _COMMON_TAG_KWARGS
 
 _RUST_REPOSITORY_SET_TAG = tag_class(
+    doc = "Tags for defining rust repository sets (where toolchains are defined).",
     attrs = _RUST_REPOSITORY_SET_TAG_ATTRS,
 )
 
 _RUST_TOOLCHAIN_TAG = tag_class(
+    doc = "Tags for defining rust toolchains (where toolchain tools are fetched).",
     attrs = {
         "aliases": attr.string_dict(
             doc = (
@@ -223,6 +225,15 @@ _RUST_TOOLCHAIN_TAG = tag_class(
     } | _COMMON_TAG_KWARGS,
 )
 
+rust = module_extension(
+    doc = "Rust toolchain extension.",
+    implementation = _rust_impl,
+    tag_classes = {
+        "repository_set": _RUST_REPOSITORY_SET_TAG,
+        "toolchain": _RUST_TOOLCHAIN_TAG,
+    },
+)
+
 _RUST_HOST_TOOLS_TAG = tag_class(
     attrs = {
         "name": attr.string(
@@ -236,15 +247,6 @@ _RUST_HOST_TOOLS_TAG = tag_class(
     } | _COMMON_TAG_KWARGS,
 )
 
-rust = module_extension(
-    doc = "Rust toolchain extension.",
-    implementation = _rust_impl,
-    tag_classes = {
-        "repository_set": _RUST_REPOSITORY_SET_TAG,
-        "toolchain": _RUST_TOOLCHAIN_TAG,
-    },
-)
-
 # This is a separate module extension so that only the host tools are
 # marked as reproducible and os and arch dependent
 def _rust_host_tools_impl(module_ctx):