Skip to content

Commit c92ef9d

Browse files
committed
Regenerate documentation
1 parent 08af7d1 commit c92ef9d

17 files changed

+207
-7
lines changed

docs/src/cargo.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
## cargo_dep_env
1212

1313
<pre>
14+
load("@rules_rust_docs//:symbols.bzl", "cargo_dep_env")
15+
1416
cargo_dep_env(<a href="#cargo_dep_env-name">name</a>, <a href="#cargo_dep_env-src">src</a>, <a href="#cargo_dep_env-out_dir">out_dir</a>)
1517
</pre>
1618

@@ -31,6 +33,8 @@ A rule for generating variables for dependent `cargo_build_script`s without a bu
3133
## cargo_build_script
3234

3335
<pre>
36+
load("@rules_rust_docs//:symbols.bzl", "cargo_build_script")
37+
3438
cargo_build_script(<a href="#cargo_build_script-name">name</a>, <a href="#cargo_build_script-edition">edition</a>, <a href="#cargo_build_script-crate_name">crate_name</a>, <a href="#cargo_build_script-crate_root">crate_root</a>, <a href="#cargo_build_script-srcs">srcs</a>, <a href="#cargo_build_script-crate_features">crate_features</a>, <a href="#cargo_build_script-version">version</a>, <a href="#cargo_build_script-deps">deps</a>,
3539
<a href="#cargo_build_script-link_deps">link_deps</a>, <a href="#cargo_build_script-proc_macro_deps">proc_macro_deps</a>, <a href="#cargo_build_script-build_script_env">build_script_env</a>, <a href="#cargo_build_script-data">data</a>, <a href="#cargo_build_script-compile_data">compile_data</a>, <a href="#cargo_build_script-tools">tools</a>, <a href="#cargo_build_script-links">links</a>,
3640
<a href="#cargo_build_script-rundir">rundir</a>, <a href="#cargo_build_script-rustc_env">rustc_env</a>, <a href="#cargo_build_script-rustc_env_files">rustc_env_files</a>, <a href="#cargo_build_script-rustc_flags">rustc_flags</a>, <a href="#cargo_build_script-visibility">visibility</a>, <a href="#cargo_build_script-tags">tags</a>, <a href="#cargo_build_script-aliases">aliases</a>,
@@ -131,6 +135,8 @@ The `hello_lib` target will be build with the flags and the environment variable
131135
## cargo_env
132136

133137
<pre>
138+
load("@rules_rust_docs//:symbols.bzl", "cargo_env")
139+
134140
cargo_env(<a href="#cargo_env-env">env</a>)
135141
</pre>
136142

@@ -178,6 +184,8 @@ str: A json encoded string of the environment variables
178184
## cargo_bootstrap_repository
179185

180186
<pre>
187+
load("@rules_rust_docs//:symbols.bzl", "cargo_bootstrap_repository")
188+
181189
cargo_bootstrap_repository(<a href="#cargo_bootstrap_repository-name">name</a>, <a href="#cargo_bootstrap_repository-srcs">srcs</a>, <a href="#cargo_bootstrap_repository-binary">binary</a>, <a href="#cargo_bootstrap_repository-build_mode">build_mode</a>, <a href="#cargo_bootstrap_repository-cargo_config">cargo_config</a>, <a href="#cargo_bootstrap_repository-cargo_lockfile">cargo_lockfile</a>, <a href="#cargo_bootstrap_repository-cargo_toml">cargo_toml</a>,
182190
<a href="#cargo_bootstrap_repository-env">env</a>, <a href="#cargo_bootstrap_repository-env_label">env_label</a>, <a href="#cargo_bootstrap_repository-repo_mapping">repo_mapping</a>, <a href="#cargo_bootstrap_repository-rust_toolchain_cargo_template">rust_toolchain_cargo_template</a>,
183191
<a href="#cargo_bootstrap_repository-rust_toolchain_rustc_template">rust_toolchain_rustc_template</a>, <a href="#cargo_bootstrap_repository-timeout">timeout</a>, <a href="#cargo_bootstrap_repository-version">version</a>)

docs/src/crate_universe.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,8 @@ There is an example of this in the "complicated dependencies" section of https:/
299299
## crates_vendor
300300

301301
<pre>
302+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crates_vendor")
303+
302304
crates_vendor(<a href="#crates_vendor-name">name</a>, <a href="#crates_vendor-annotations">annotations</a>, <a href="#crates_vendor-bazel">bazel</a>, <a href="#crates_vendor-buildifier">buildifier</a>, <a href="#crates_vendor-cargo_bazel">cargo_bazel</a>, <a href="#crates_vendor-cargo_config">cargo_config</a>, <a href="#crates_vendor-cargo_lockfile">cargo_lockfile</a>,
303305
<a href="#crates_vendor-generate_binaries">generate_binaries</a>, <a href="#crates_vendor-generate_build_scripts">generate_build_scripts</a>, <a href="#crates_vendor-generate_target_compatible_with">generate_target_compatible_with</a>, <a href="#crates_vendor-manifests">manifests</a>,
304306
<a href="#crates_vendor-mode">mode</a>, <a href="#crates_vendor-packages">packages</a>, <a href="#crates_vendor-render_config">render_config</a>, <a href="#crates_vendor-repository_name">repository_name</a>, <a href="#crates_vendor-splicing_config">splicing_config</a>,
@@ -405,6 +407,8 @@ call against the generated workspace. The following table describes how to contr
405407
## aliases
406408

407409
<pre>
410+
load("@rules_rust//crate_universe:docs_workspace.bzl", "aliases")
411+
408412
aliases(<a href="#aliases-normal">normal</a>, <a href="#aliases-normal_dev">normal_dev</a>, <a href="#aliases-proc_macro">proc_macro</a>, <a href="#aliases-proc_macro_dev">proc_macro_dev</a>, <a href="#aliases-build">build</a>, <a href="#aliases-build_proc_macro">build_proc_macro</a>, <a href="#aliases-package_name">package_name</a>)
409413
</pre>
410414

@@ -437,6 +441,8 @@ dict: The aliases of all associated packages
437441
## all_crate_deps
438442

439443
<pre>
444+
load("@rules_rust//crate_universe:docs_workspace.bzl", "all_crate_deps")
445+
440446
all_crate_deps(<a href="#all_crate_deps-normal">normal</a>, <a href="#all_crate_deps-normal_dev">normal_dev</a>, <a href="#all_crate_deps-proc_macro">proc_macro</a>, <a href="#all_crate_deps-proc_macro_dev">proc_macro_dev</a>, <a href="#all_crate_deps-build">build</a>, <a href="#all_crate_deps-build_proc_macro">build_proc_macro</a>,
441447
<a href="#all_crate_deps-package_name">package_name</a>)
442448
</pre>
@@ -470,6 +476,8 @@ list: A list of labels to generated rust targets (str)
470476
## crate.annotation
471477

472478
<pre>
479+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate")
480+
473481
crate.annotation(<a href="#crate.annotation-version">version</a>, <a href="#crate.annotation-additive_build_file">additive_build_file</a>, <a href="#crate.annotation-additive_build_file_content">additive_build_file_content</a>, <a href="#crate.annotation-alias_rule">alias_rule</a>,
474482
<a href="#crate.annotation-build_script_compile_data">build_script_compile_data</a>, <a href="#crate.annotation-build_script_data">build_script_data</a>, <a href="#crate.annotation-build_script_tools">build_script_tools</a>,
475483
<a href="#crate.annotation-build_script_data_glob">build_script_data_glob</a>, <a href="#crate.annotation-build_script_deps">build_script_deps</a>, <a href="#crate.annotation-build_script_env">build_script_env</a>,
@@ -531,6 +539,8 @@ string: A json encoded string containing the specified version and separately al
531539
## crate.select
532540

533541
<pre>
542+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate")
543+
534544
crate.select(<a href="#crate.select-common">common</a>, <a href="#crate.select-selects">selects</a>)
535545
</pre>
536546

@@ -554,6 +564,8 @@ struct: A struct representing the Starlark Select.
554564
## crate.spec
555565

556566
<pre>
567+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate")
568+
557569
crate.spec(<a href="#crate.spec-package">package</a>, <a href="#crate.spec-version">version</a>, <a href="#crate.spec-artifact">artifact</a>, <a href="#crate.spec-lib">lib</a>, <a href="#crate.spec-default_features">default_features</a>, <a href="#crate.spec-features">features</a>, <a href="#crate.spec-git">git</a>, <a href="#crate.spec-branch">branch</a>, <a href="#crate.spec-tag">tag</a>, <a href="#crate.spec-rev">rev</a>)
558570
</pre>
559571

@@ -590,6 +602,8 @@ string: A json encoded string of all inputs
590602
## crate.workspace_member
591603

592604
<pre>
605+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate")
606+
593607
crate.workspace_member(<a href="#crate.workspace_member-version">version</a>, <a href="#crate.workspace_member-sha256">sha256</a>)
594608
</pre>
595609

@@ -613,6 +627,8 @@ string: A json encoded string of all inputs
613627
## crate_deps
614628

615629
<pre>
630+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate_deps")
631+
616632
crate_deps(<a href="#crate_deps-deps">deps</a>, <a href="#crate_deps-package_name">package_name</a>)
617633
</pre>
618634

@@ -636,6 +652,8 @@ list: A list of labels to generated rust targets (str)
636652
## crate_repositories
637653

638654
<pre>
655+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate_repositories")
656+
639657
crate_repositories()
640658
</pre>
641659

@@ -652,6 +670,8 @@ A list of repos visible to the module through the module extension.
652670
## crate_universe_dependencies
653671

654672
<pre>
673+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crate_universe_dependencies")
674+
655675
crate_universe_dependencies(<a href="#crate_universe_dependencies-rust_version">rust_version</a>, <a href="#crate_universe_dependencies-bootstrap">bootstrap</a>, <a href="#crate_universe_dependencies-kwargs">kwargs</a>)
656676
</pre>
657677

@@ -677,6 +697,8 @@ list[struct(repo=str, is_dev_dep=bool)]: A list of the repositories
677697
## render_config
678698

679699
<pre>
700+
load("@rules_rust//crate_universe:docs_workspace.bzl", "render_config")
701+
680702
render_config(<a href="#render_config-build_file_template">build_file_template</a>, <a href="#render_config-crate_label_template">crate_label_template</a>, <a href="#render_config-crate_repository_template">crate_repository_template</a>,
681703
<a href="#render_config-crates_module_template">crates_module_template</a>, <a href="#render_config-default_alias_rule">default_alias_rule</a>, <a href="#render_config-default_package_name">default_package_name</a>,
682704
<a href="#render_config-generate_target_compatible_with">generate_target_compatible_with</a>, <a href="#render_config-platforms_template">platforms_template</a>, <a href="#render_config-regen_command">regen_command</a>, <a href="#render_config-vendor_mode">vendor_mode</a>,
@@ -725,6 +747,8 @@ string: A json encoded struct to match the Rust `config::RenderConfig` struct
725747
## splicing_config
726748

727749
<pre>
750+
load("@rules_rust//crate_universe:docs_workspace.bzl", "splicing_config")
751+
728752
splicing_config(<a href="#splicing_config-resolver_version">resolver_version</a>)
729753
</pre>
730754

@@ -750,6 +774,8 @@ str: A json encoded string of the parameters provided
750774
## crates_repository
751775

752776
<pre>
777+
load("@rules_rust//crate_universe:docs_workspace.bzl", "crates_repository")
778+
753779
crates_repository(<a href="#crates_repository-name">name</a>, <a href="#crates_repository-annotations">annotations</a>, <a href="#crates_repository-cargo_config">cargo_config</a>, <a href="#crates_repository-cargo_lockfile">cargo_lockfile</a>, <a href="#crates_repository-generate_binaries">generate_binaries</a>,
754780
<a href="#crates_repository-generate_build_scripts">generate_build_scripts</a>, <a href="#crates_repository-generate_target_compatible_with">generate_target_compatible_with</a>, <a href="#crates_repository-generator">generator</a>,
755781
<a href="#crates_repository-generator_sha256s">generator_sha256s</a>, <a href="#crates_repository-generator_urls">generator_urls</a>, <a href="#crates_repository-isolated">isolated</a>, <a href="#crates_repository-lockfile">lockfile</a>, <a href="#crates_repository-manifests">manifests</a>, <a href="#crates_repository-packages">packages</a>, <a href="#crates_repository-quiet">quiet</a>,
@@ -879,6 +905,7 @@ CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_i
879905
**ENVIRONMENT VARIABLES**
880906

881907
This repository rule depends on the following environment variables:
908+
882909
* `CARGO_BAZEL_GENERATOR_URL`
883910
* `CARGO_BAZEL_GENERATOR_SHA256`
884911
* `CARGO_BAZEL_REPIN`

0 commit comments

Comments
 (0)