src/main/java/com/google/devtools/build/docgen/templates/skylark-library.vm

---
layout: documentation
title: ${module.title}
---

<div style="background-color: #EFCBCB; color: #AE2B2B;  border: 1px solid #AE2B2B; border-radius: 5px; border-left: 10px solid #AE2B2B; padding: 0.5em;">
<b>IMPORTANT:</b> The Bazel docs have moved! Please update your bookmark to <a href="https://bazel.build/rules/lib/${module.name}" style="color: #0000EE;">https://bazel.build/rules/lib/${module.name}</a>
<p/>
You can <a href="https://blog.bazel.build/2022/02/17/Launching-new-Bazel-site.html" style="color: #0000EE;">read about</a> the migration, and let us <a href="https://forms.gle/onkAkr2ZwBmcbWXj7" style="color: #0000EE;">know what you think</a>.
</div>

<a href="../concepts.html">Extensions</a> &gt;
<a href="skylark-overview.html">API reference</a> &gt;
${module.title}

<!-- {% raw %} -->
<h1 id="modules.${module.name}">${module.title}</h1>

${module.documentation}

#if (!$module.methods.isEmpty())
<div class="toc">
  <h2>Members</h2>
  <ul>
  #foreach ($method in $module.methods)
    #if ($method.documented())
    <li>
      <a href="#${method.name}">${method.name}</a>
    </li>
    #end
  #end
  </ul>
</div>
#end

#foreach ($method in $module.methods)
  #if ($method.documented())
    <h2 id="${method.name}">${method.name}</h2>
    #if (!$method.signature.isEmpty())
    <p><pre class="rule-signature">${method.signature}</pre></p>
    #end

    ${method.documentation}

    #if (!$method.params.isEmpty())
      <!-- no_toc is a class used by the jekyll-toc plugin for docs.bazel.build -->
      <h3 class="no_toc">Parameters</h3>
      <table class="table table-bordered table-condensed table-params">
        <colgroup>
          <col class="col-param">
          <col class="param-description">
        </colgroup>
        <thead>
          <tr>
            <th>Parameter</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
        #foreach ($param in $method.params)
          <tr>
            <td id="${param.method.name}.${param.name}">
              <code>${param.name}</code>
            </td>
            <td>
            #if (!$param.type.isEmpty())
              <code>${param.type}</code>;
            #end
            #if (!$param.defaultValue.isEmpty())
             default = ${param.defaultValue}<br/>
            #else
             required<br/>
            #end
              ${param.documentation}
            </td>
          </tr>
        #end
        </tbody>
      </table>
    #end
    ${method.returnTypeExtraMessage}
  #end
#end

<!-- {% endraw %} -->