Skip to content

Commit 142cc88

Browse files
committed
Regenerate documentation
1 parent b7c2279 commit 142cc88

File tree

2 files changed

+62
-62
lines changed

2 files changed

+62
-62
lines changed

docs/flatten.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -446,38 +446,38 @@ rust_doc(<a href="#rust_doc-name">name</a>, <a href="#rust_doc-crate">crate</a>,
446446
Generates code documentation.
447447

448448
Example:
449-
Suppose you have the following directory structure for a Rust library crate:
449+
Suppose you have the following directory structure for a Rust library crate:
450450

451-
```
452-
[workspace]/
453-
WORKSPACE
454-
hello_lib/
455-
BUILD
456-
src/
457-
lib.rs
458-
```
451+
```
452+
[workspace]/
453+
WORKSPACE
454+
hello_lib/
455+
BUILD
456+
src/
457+
lib.rs
458+
```
459459

460-
To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
460+
To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
461461

462-
[rustdoc]: https://doc.rust-lang.org/book/documentation.html
462+
[rustdoc]: https://doc.rust-lang.org/book/documentation.html
463463

464-
```python
465-
package(default_visibility = ["//visibility:public"])
464+
```python
465+
package(default_visibility = ["//visibility:public"])
466466

467-
load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
467+
load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
468468

469-
rust_library(
470-
name = "hello_lib",
471-
srcs = ["src/lib.rs"],
472-
)
469+
rust_library(
470+
name = "hello_lib",
471+
srcs = ["src/lib.rs"],
472+
)
473473

474-
rust_doc(
475-
name = "hello_lib_doc",
476-
crate = ":hello_lib",
477-
)
478-
```
474+
rust_doc(
475+
name = "hello_lib_doc",
476+
crate = ":hello_lib",
477+
)
478+
```
479479

480-
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`.
480+
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`.
481481

482482

483483
**ATTRIBUTES**
@@ -510,14 +510,14 @@ Suppose you have the following directory structure for a Rust library crate:
510510

511511
```output
512512
[workspace]/
513-
WORKSPACE
514-
hello_lib/
515-
BUILD
516-
src/
517-
lib.rs
513+
WORKSPACE
514+
hello_lib/
515+
BUILD
516+
src/
517+
lib.rs
518518
```
519519

520-
To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` target that depends on the `hello_lib` `rust_library` target:
520+
To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` target that depends on the `hello_lib` `rust_library` target:
521521

522522
[doc-test]: https://doc.rust-lang.org/book/documentation.html#documentation-as-tests
523523

@@ -546,7 +546,7 @@ Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation t
546546
| Name | Description | Type | Mandatory | Default |
547547
| :------------- | :------------- | :------------- | :------------- | :------------- |
548548
| <a id="rust_doc_test-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
549-
| <a id="rust_doc_test-crate"></a>crate | The label of the target to generate code documentation for.<br><br><code>rust_doc_test</code> can generate HTML code documentation for the source files of <code>rust_library</code> or <code>rust_binary</code> targets. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
549+
| <a id="rust_doc_test-crate"></a>crate | The label of the target to generate code documentation for. <code>rust_doc_test</code> can generate HTML code documentation for the source files of <code>rust_library</code> or <code>rust_binary</code> targets. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
550550
| <a id="rust_doc_test-dep"></a>dep | __deprecated__: use <code>crate</code> | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
551551

552552

docs/rust_doc.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,38 @@ rust_doc(<a href="#rust_doc-name">name</a>, <a href="#rust_doc-crate">crate</a>,
1515
Generates code documentation.
1616

1717
Example:
18-
Suppose you have the following directory structure for a Rust library crate:
18+
Suppose you have the following directory structure for a Rust library crate:
1919

20-
```
21-
[workspace]/
22-
WORKSPACE
23-
hello_lib/
24-
BUILD
25-
src/
26-
lib.rs
27-
```
20+
```
21+
[workspace]/
22+
WORKSPACE
23+
hello_lib/
24+
BUILD
25+
src/
26+
lib.rs
27+
```
2828

29-
To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
29+
To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
3030

31-
[rustdoc]: https://doc.rust-lang.org/book/documentation.html
31+
[rustdoc]: https://doc.rust-lang.org/book/documentation.html
3232

33-
```python
34-
package(default_visibility = ["//visibility:public"])
33+
```python
34+
package(default_visibility = ["//visibility:public"])
3535

36-
load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
36+
load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
3737

38-
rust_library(
39-
name = "hello_lib",
40-
srcs = ["src/lib.rs"],
41-
)
38+
rust_library(
39+
name = "hello_lib",
40+
srcs = ["src/lib.rs"],
41+
)
4242

43-
rust_doc(
44-
name = "hello_lib_doc",
45-
crate = ":hello_lib",
46-
)
47-
```
43+
rust_doc(
44+
name = "hello_lib_doc",
45+
crate = ":hello_lib",
46+
)
47+
```
4848

49-
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`.
49+
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`.
5050

5151

5252
**ATTRIBUTES**
@@ -79,14 +79,14 @@ Suppose you have the following directory structure for a Rust library crate:
7979

8080
```output
8181
[workspace]/
82-
WORKSPACE
83-
hello_lib/
84-
BUILD
85-
src/
86-
lib.rs
82+
WORKSPACE
83+
hello_lib/
84+
BUILD
85+
src/
86+
lib.rs
8787
```
8888

89-
To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` target that depends on the `hello_lib` `rust_library` target:
89+
To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` target that depends on the `hello_lib` `rust_library` target:
9090

9191
[doc-test]: https://doc.rust-lang.org/book/documentation.html#documentation-as-tests
9292

@@ -115,7 +115,7 @@ Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation t
115115
| Name | Description | Type | Mandatory | Default |
116116
| :------------- | :------------- | :------------- | :------------- | :------------- |
117117
| <a id="rust_doc_test-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
118-
| <a id="rust_doc_test-crate"></a>crate | The label of the target to generate code documentation for.<br><br><code>rust_doc_test</code> can generate HTML code documentation for the source files of <code>rust_library</code> or <code>rust_binary</code> targets. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
118+
| <a id="rust_doc_test-crate"></a>crate | The label of the target to generate code documentation for. <code>rust_doc_test</code> can generate HTML code documentation for the source files of <code>rust_library</code> or <code>rust_binary</code> targets. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
119119
| <a id="rust_doc_test-dep"></a>dep | __deprecated__: use <code>crate</code> | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
120120

121121

0 commit comments

Comments
 (0)