docs/index.html

<!--
Documentation generated by Skydoc
-->
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width initial-scale=1" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge">

    <title>Overview</title>

    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700" type="text/css">
    <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
    <link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">
    <script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>
    <link rel="stylesheet" href="https://bazelbuild.github.io/rules_kotlin/main.css">
  </head>
  <body>
    <div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer
      mdl-layout--fixed-header">
      <header class="mdl-layout__header">
        <div class="mdl-layout__header-row">
          <span class="mdl-layout-title">Overview</span>
        </div>
      </header>
      <div class="mdl-layout__drawer">
        <span class="mdl-layout-title">Bazel</span>
        <nav class="drawer-nav">
          <ul class="drawer-nav">
            
<li><a href="https://bazelbuild.github.io/rules_kotlin/index.html">Overview</a></li>
<li>
  <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html">Kotlin Rules</a>
  <ul>
    <li><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#overview">Overview</a></li>
    <li>
      <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_binary">
        kt_jvm_binary
      </a>
    </li>
    <li>
      <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_import">
        kt_jvm_import
      </a>
    </li>
    <li>
      <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_library">
        kt_jvm_library
      </a>
    </li>
    <li>
      <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_test">
        kt_jvm_test
      </a>
    </li>
  </ul>
</li>
<li>
  <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html">toolchains Rules</a>
  <ul>
    <li>
      <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html#kt_toolchain">
        kt_toolchain
      </a>
    </li>
  </ul>
</li>

          </ul>
        </nav>
      </div>

      <main class="mdl-layout__content">
        <div class="page-content">
<h1>Overview</h1>


<nav class="toc">
  <h2>Rule sets</h2>
  <ul>
    <li><a href="#kotlin">Kotlin Rules</a></li>
    <li><a href="#toolchains">toolchains Rules</a></li>
  </ul>
</nav>

<h2><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html" id="kotlin">Kotlin Rules</a></h2>

<h3>Rules</h3>
<table class="overview-table">
  <colgroup>
    <col class="col-name" />
    <col class="col-description" />
  </colgroup>
  <tbody>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_binary">
          <code>kt_jvm_binary</code>
        </a>
      </td>
      <td>
        <p>Builds a Java archive ("jar file"), plus a wrapper shell script with the same name as the rule. The wrapper shell script uses a classpath that includes,
among other things, a jar file for each library on which the binary depends.</p>

      </td>
    </tr>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_import">
          <code>kt_jvm_import</code>
        </a>
      </td>
      <td>
        <p>(experimental) Import Kotlin jars.</p>

      </td>
    </tr>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_library">
          <code>kt_jvm_library</code>
        </a>
      </td>
      <td>
        <p>This rule compiles and links Kotlin and Java sources into a .jar file.</p>

      </td>
    </tr>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_jvm_test">
          <code>kt_jvm_test</code>
        </a>
      </td>
      <td>
        <p>Setup a simple kotlin_test.</p>

      </td>
    </tr>
  </tbody>
</table>
<h3>Macros</h3>
<table class="overview-table">
  <colgroup>
    <col class="col-name" />
    <col class="col-description" />
  </colgroup>
  <tbody>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kotlin_repositories">
          <code>kotlin_repositories</code>
        </a>
      </td>
      <td>
        <p>Call this in the WORKSPACE file to setup the Kotlin rules.</p>

      </td>
    </tr>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/kotlin.html#kt_register_toolchains">
          <code>kt_register_toolchains</code>
        </a>
      </td>
      <td>
        <p>register all default toolchains</p>

      </td>
    </tr>
  </tbody>
</table>
<h2><a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html" id="toolchains">toolchains Rules</a></h2>

<h3>Rules</h3>
<table class="overview-table">
  <colgroup>
    <col class="col-name" />
    <col class="col-description" />
  </colgroup>
  <tbody>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html#kt_toolchain">
          <code>kt_toolchain</code>
        </a>
      </td>
      <td>
        <p>The kotlin jvm toolchain</p>

      </td>
    </tr>
  </tbody>
</table>
<h3>Macros</h3>
<table class="overview-table">
  <colgroup>
    <col class="col-name" />
    <col class="col-description" />
  </colgroup>
  <tbody>
    <tr>
      <td>
        <a href="https://bazelbuild.github.io/rules_kotlin/kotlin/toolchains.html#define_kt_toolchain">
          <code>define_kt_toolchain</code>
        </a>
      </td>
      <td>
        <p>Define a Kotlin JVM Toolchain, the name is used in the <code>toolchain</code> rule so can be used to register the toolchain in the WORKSPACE file.</p>

      </td>
    </tr>
  </tbody>
</table>


        </div>

        <footer class="mdl-mini-footer">
          <div class="mdl-mini-footer__left-section">
            <div class="mdl-logo">Bazel</div>
            <ul class="mdl-mini-footer__link-list">
              <li><a href="https://bazel.build">Home</a></li>
              <li><a href="https://github.com/bazelbuild">GitHub</a></li>
            </ul>
          </div>
        </footer>
      </main>
    </div>
  </body>
</html>