<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/rust_doc.md - fork/rules_rust @ cleanup</title>
<meta name="description" content="docs/src/rust_doc.md in fork/rules_rust at cleanup.">
<meta property="og:title" content="docs/src/rust_doc.md - fork/rules_rust @ cleanup">
<meta property="og:description" content="docs/src/rust_doc.md in fork/rules_rust at cleanup.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="cleanup" data-tip="a4c87621ebc87a3e20fc4a1cdb273945ddb5ac86">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Thaler Benedek</span><span class="commit-message" data-commit="66bcafef09e2e1af9c1f4ced3deef35274130bd5">Add proc_macro_deps for rust_doc_test (#2928)</span><span class="snapshot-sha sha" data-commit="66bcafef09e2e1af9c1f4ced3deef35274130bd5">66bcafef</span><time datetime="2024-11-09T00:19:11+01:00" title="2024-11-09 00:19:11 +0100">2024-11-09</time></p>
<header class="topbar"><details class="switcher"><summary>cleanup</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/cleanup/tree/docs/">docs</a> / <a href="/fork/rules_rust/ref/cleanup/tree/docs/src/">src</a> / <span class="cur">rust_doc.md</span></nav>
<span class="view-stats"><span>5.5 KiB</span><span>122 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/b16f50d380dce3da3d673562b469f3187403898a/docs/src/rust_doc.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;
<h1>Rust Doc</h1>
<ul>
<li><a href="#rust_doc">rust_doc</a></li>
<li><a href="#rust_doc_test">rust_doc_test</a></li>
</ul>
<p>&lt;a id="rust_doc"&gt;&lt;/a&gt;</p>
<h2>rust_doc</h2>
&lt;pre&gt;
rust_doc(&lt;a href="#rust_doc-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_doc-crate"&gt;crate&lt;/a&gt;, &lt;a href="#rust_doc-html_after_content"&gt;html_after_content&lt;/a&gt;, &lt;a href="#rust_doc-html_before_content"&gt;html_before_content&lt;/a&gt;, &lt;a href="#rust_doc-html_in_header"&gt;html_in_header&lt;/a&gt;, &lt;a href="#rust_doc-markdown_css"&gt;markdown_css&lt;/a&gt;,
         &lt;a href="#rust_doc-rustc_flags"&gt;rustc_flags&lt;/a&gt;, &lt;a href="#rust_doc-rustdoc_flags"&gt;rustdoc_flags&lt;/a&gt;)
&lt;/pre&gt;
<p>Generates code documentation.</p>
<p>Example:
Suppose you have the following directory structure for a Rust library crate:</p>
<pre>[workspace]/
    WORKSPACE
    hello_lib/
        BUILD
        src/
            lib.rs
</pre>
<p>To build <a href="https://doc.rust-lang.org/book/documentation.html"><code>rustdoc</code></a> documentation for the <code>hello_lib</code> crate, define     a <code>rust_doc</code> rule that depends on the the <code>hello_lib</code> <code>rust_library</code> target:</p>
<pre class="language-python"><a-f>package</a-f>(<a-v>default_visibility</a-v> <a-o>=</a-o> [<a-s>&quot;//visibility:public&quot;</a-s>])

<a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s>, <a-s>&quot;rust_library&quot;</a-s>, <a-s>&quot;rust_doc&quot;</a-s>)

<a-f>rust_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;hello_lib&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;src/lib.rs&quot;</a-s>],
)

<a-f>rust_doc</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;hello_lib_doc&quot;</a-s>,
    <a-v>crate</a-v> <a-o>=</a-o> <a-s>&quot;:hello_lib&quot;</a-s>,
)</pre>
<p>Running <code>bazel build //hello_lib:hello_lib_doc</code> will build a zip file containing     the documentation for the <code>hello_lib</code> library crate generated by <code>rustdoc</code>.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_doc-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-crate"&gt;&lt;/a&gt;crate</td><td style="text-align: left">The label of the target to generate code documentation for.&lt;br&gt;&lt;br&gt;<code>rust_doc</code> can generate HTML code documentation for the source files of <code>rust_library</code> or <code>rust_binary</code> targets.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-html_after_content"&gt;&lt;/a&gt;html_after_content</td><td style="text-align: left">File to add in <code>&lt;body&gt;</code>, after content.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-html_before_content"&gt;&lt;/a&gt;html_before_content</td><td style="text-align: left">File to add in <code>&lt;body&gt;</code>, before content.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-html_in_header"&gt;&lt;/a&gt;html_in_header</td><td style="text-align: left">File to add to <code>&lt;head&gt;</code>.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-markdown_css"&gt;&lt;/a&gt;markdown_css</td><td style="text-align: left">CSS files to include via <code>&lt;link&gt;</code> in a rendered Markdown file.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;List of labels&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-rustc_flags"&gt;&lt;/a&gt;rustc_flags</td><td style="text-align: left"><strong>Deprecated</strong>: use <code>rustdoc_flags</code> instead</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc-rustdoc_flags"&gt;&lt;/a&gt;rustdoc_flags</td><td style="text-align: left">List of flags passed to <code>rustdoc</code>.&lt;br&gt;&lt;br&gt;These strings are subject to Make variable expansion for predefined source/output path variables like <code>$location</code>, <code>$execpath</code>, and <code>$rootpath</code>. This expansion is useful if you wish to pass a generated file of arguments to rustc: <code>@$(location //package:target)</code>.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
</tbody></table>
<p>&lt;a id="rust_doc_test"&gt;&lt;/a&gt;</p>
<h2>rust_doc_test</h2>
&lt;pre&gt;
rust_doc_test(&lt;a href="#rust_doc_test-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_doc_test-deps"&gt;deps&lt;/a&gt;, &lt;a href="#rust_doc_test-crate"&gt;crate&lt;/a&gt;, &lt;a href="#rust_doc_test-proc_macro_deps"&gt;proc_macro_deps&lt;/a&gt;)
&lt;/pre&gt;
<p>Runs Rust documentation tests.</p>
<p>Example:</p>
<p>Suppose you have the following directory structure for a Rust library crate:</p>
<pre>[workspace]/
WORKSPACE
hello_lib/
    BUILD
    src/
        lib.rs
</pre>
<p>To run <a href="https://doc.rust-lang.org/book/documentation.html#documentation-as-tests">documentation tests</a> for the <code>hello_lib</code> crate, define a <code>rust_doc_test</code>         target that depends on the <code>hello_lib</code> <code>rust_library</code> target:</p>
<pre class="language-python"><a-f>package</a-f>(<a-v>default_visibility</a-v> <a-o>=</a-o> [<a-s>&quot;//visibility:public&quot;</a-s>])

<a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s>, <a-s>&quot;rust_library&quot;</a-s>, <a-s>&quot;rust_doc_test&quot;</a-s>)

<a-f>rust_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;hello_lib&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;src/lib.rs&quot;</a-s>],
)

<a-f>rust_doc_test</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;hello_lib_doc_test&quot;</a-s>,
    <a-v>crate</a-v> <a-o>=</a-o> <a-s>&quot;:hello_lib&quot;</a-s>,
)</pre>
<p>Running <code>bazel test //hello_lib:hello_lib_doc_test</code> will run all documentation tests for the <code>hello_lib</code> library crate.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_doc_test-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc_test-deps"&gt;&lt;/a&gt;deps</td><td style="text-align: left">List of other libraries to be linked to this library target.&lt;br&gt;&lt;br&gt;These can be either other <code>rust_library</code> targets or <code>cc_library</code> targets if linking a native library.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;List of labels&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc_test-crate"&gt;&lt;/a&gt;crate</td><td style="text-align: left">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.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_doc_test-proc_macro_deps"&gt;&lt;/a&gt;proc_macro_deps</td><td style="text-align: left">List of <code>rust_proc_macro</code> targets used to help build this library target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;List of labels&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
</tbody></table>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>#</a-p> <a-tt>Rust Doc</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>* </a-p>[rust_doc](#rust_doc)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>* </a-p>[rust_doc_test](#rust_doc_test)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>&lt;a id=&quot;rust_doc&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>## </a-p><a-tt>rust_doc</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>rust_doc(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-crate</a-s><a-p>&quot;&gt;crate&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-html_after_content</a-s><a-p>&quot;&gt;html_after_content&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-html_before_content</a-s><a-p>&quot;&gt;html_before_content&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-html_in_header</a-s><a-p>&quot;&gt;html_in_header&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-markdown_css</a-s><a-p>&quot;&gt;markdown_css&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>         &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-rustc_flags</a-s><a-p>&quot;&gt;rustc_flags&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc-rustdoc_flags</a-s><a-p>&quot;&gt;rustdoc_flags&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>Generates code documentation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>Suppose you have the following directory structure for a Rust library crate:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>[workspace]/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>    WORKSPACE</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    hello_lib/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>        BUILD</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>        src/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>            lib.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>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:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-tu>[rustdoc]</a-tu><a-p>: </a-p><a-tu>https://doc.rust-lang.org/book/documentation.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>package(</a-p><a-v>default_visibility</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;//visibility:public&quot;</a-s><a-p>])</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_library&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_doc&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>rust_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;hello_lib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;src/lib.rs&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>rust_doc(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;hello_lib_doc&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>    </a-p><a-v>crate</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:hello_lib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>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`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>**ATTRIBUTES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>| Name  | Description | Type | Mandatory | Default |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-crate&quot;&gt;&lt;/a&gt;crate |  The label of the target to generate code documentation for.&lt;br&gt;&lt;br&gt;`rust_doc` can generate HTML code documentation for the source files of `rust_library` or `rust_binary` targets.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-html_after_content&quot;&gt;&lt;/a&gt;html_after_content |  File to add in `&lt;body&gt;`, after content.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-html_before_content&quot;&gt;&lt;/a&gt;html_before_content |  File to add in `&lt;body&gt;`, before content.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-html_in_header&quot;&gt;&lt;/a&gt;html_in_header |  File to add to `&lt;head&gt;`.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-markdown_css&quot;&gt;&lt;/a&gt;markdown_css |  CSS files to include via `&lt;link&gt;` in a rendered Markdown file.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-rustc_flags&quot;&gt;&lt;/a&gt;rustc_flags |  **Deprecated**: use `rustdoc_flags` instead   | List of strings | optional |  `[]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_doc-rustdoc_flags&quot;&gt;&lt;/a&gt;rustdoc_flags |  List of flags passed to `rustdoc`.&lt;br&gt;&lt;br&gt;These strings are subject to Make variable expansion for predefined source/output path variables like `$location`, `$execpath`, and `$rootpath`. This expansion is useful if you wish to pass a generated file of arguments to rustc: `@$(location //package:target)`.   | List of strings | optional |  `[]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>&lt;a id=&quot;rust_doc_test&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>## </a-p><a-tt>rust_doc_test</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>rust_doc_test(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc_test-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc_test-deps</a-s><a-p>&quot;&gt;deps&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc_test-crate</a-s><a-p>&quot;&gt;crate&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_doc_test-proc_macro_deps</a-s><a-p>&quot;&gt;proc_macro_deps&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>Runs Rust documentation tests.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>Suppose you have the following directory structure for a Rust library crate:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>```</a-p><a-tl>output</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>[workspace]/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>WORKSPACE</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>hello_lib/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>    BUILD</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>    src/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>        lib.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>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:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-tu>[doc-test]</a-tu><a-p>: </a-p><a-tu>https://doc.rust-lang.org/book/documentation.html#documentation-as-tests</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>package(</a-p><a-v>default_visibility</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;//visibility:public&quot;</a-s><a-p>])</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_library&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_doc_test&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>rust_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;hello_lib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;src/lib.rs&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>rust_doc_test(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;hello_lib_doc_test&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>    </a-p><a-v>crate</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:hello_lib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text">Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation tests for the `hello_lib` library crate.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text">**ATTRIBUTES**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text">| Name  | Description | Type | Mandatory | Default |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text">| :------------- | :------------- | :------------- | :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text">| &lt;a id=&quot;rust_doc_test-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text">| &lt;a id=&quot;rust_doc_test-deps&quot;&gt;&lt;/a&gt;deps |  List of other libraries to be linked to this library target.&lt;br&gt;&lt;br&gt;These can be either other `rust_library` targets or `cc_library` targets if linking a native library.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text">| &lt;a id=&quot;rust_doc_test-crate&quot;&gt;&lt;/a&gt;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.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text">| &lt;a id=&quot;rust_doc_test-proc_macro_deps&quot;&gt;&lt;/a&gt;proc_macro_deps |  List of `rust_proc_macro` targets used to help build this library target.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
