aiken/crates/project/templates/module.html

{% extends "_layout.html" %}

{% block sidebar_content %}
{% if !types.is_empty() %}
<h2>Types</h2>
<ul>
  {% for type_info in types %}
  <li><a href="#{{ type_info.name }}">{{ type_info.name }}</a></li>
  {% endfor %}
</ul>
{% endif %}

{% if !constants.is_empty() %}
<h2>Constants</h2>
<ul>
  {% for constant in constants %}
  <li><a href="#{{ constant.name }}">{{ constant.name }}</a></li>
  {% endfor %}
</ul>
{% endif %}

{% if !functions.is_empty() %}
<h2>Functions</h2>
<ul>
  {% for function in functions %}
  <li><a href="#{{ function.name }}">{{ function.name }}</a></li>
  {% endfor %}
</ul>
{% endif %}
{% endblock %}

{% block content %}
<h1 id="module-name" class="module-name">
  <a href="#module-name">{{ module_name }}</a>
</h1>
{{ documentation|safe }}

{% if !types.is_empty() %}
<section class="module-members">
  <h1 id="module-types" class="module-member-kind">
    <a href="#module-types">Types</a>
  </h1>

  {% for type_info in types %}
  <div class="member">
    <div class="member-name">
      <h2 id="{{ type_info.name }}">
        <a href="#{{ type_info.name }}">
          {{ type_info.name }}
        </a>
      </h2>
      {% if !type_info.source_url.is_empty() %}
      <!-- TODO: support source linking
      <a class="member-source" alt="View Source" title="View Source" href="{{ type_info.source_url|safe }}">
        &lt;/&gt;
      </a>
      -->
      {% endif %}
    </div>
    <div class="custom-type-constructors">
      <div class="rendered-markdown">{{ type_info.documentation|safe }}</div>
      <pre><code class="hljs aiken">{{ type_info.definition }}</code></pre>
      {% if !type_info.constructors.is_empty() %}
      <h3>
        Constructors
      </h3>
      <ul class="constructor-list">
        {% for constructor in type_info.constructors %}
        <li class="constructor-item">
          <div class="constructor-row">
            <svg class="icon icon-star"><use xlink:href="#icon-star"></use></svg>
            <pre class="constructor-name"><code class="hljs aiken">{{ constructor.definition }}</code></pre>
          </div>

          <div class="constructor-item-docs">
            {{ constructor.documentation|safe }}

            {% if !constructor.arguments.is_empty() %}
            <h4>
              Arguments
            </h4>

            <ul class="constructor-argument-list">
            {% for argument in constructor.arguments %}
              <li>
                <div class="constructor-argument-item">
                  <p class="constructor-argument-label">
                    <i>{{ argument.label }}</i>
                  </p>
                  <div class="constructor-argument-doc">
                    {{ argument.documentation|safe }}
                  </div>
                </div>
              </li>
            {% endfor %}
            </ul>
            {% endif %}
          </div>
        </li>
        {% endfor %}
      </ul>
      {% endif %}
    </div>
  </div>
  {% endfor %}
</section>
{% endif %}

{% if !constants.is_empty() %}
<section class="module-members">
  <h1 id="module-constants" class="module-member-kind">
    <a href="#module-constants">Constants</a>
  </h1>

  {% for constant in constants %}
  <div class="member">
    <div class="member-name">
      <h2 id="{{ constant.name }}">
        <a href="#{{ constant.name }}">
          {{ constant.name }}
        </a>
      </h2>
      {% if !constant.source_url.is_empty() %}
      <!-- TODO: support source linking
      <a class="member-source" alt="View Source" title="View Source" href="{{ constant.source_url|safe }}">
        &lt;/&gt;
      </a>
      -->
      {% endif %}
    </div>
    <pre><code class="hljs aiken">{{ constant.definition }}</code></pre>
    <div class="rendered-markdown">{{ constant.documentation|safe }}</div>
  </div>
  {% endfor %}
</section>
{% endif %}

{% if !functions.is_empty() %}
<section class="module-members">
  <h1 id="module-functions" class="module-member-kind">
    <a href="#module-functions">Functions</a>
  </h1>
  {% for function in functions %}
  <div class="member">
    <div class="member-name">
      <h2 id="{{ function.name }}">
        <a href="#{{ function.name }}">
          {{ function.name }}
        </a>
      </h2>
      {% if !function.source_url.is_empty() %}
      <!-- TODO: support source linking
      <a class="member-source" alt="View Source" title="View Source" href="{{ function.source_url|safe }}">
        &lt;/&gt;
      </a>
      -->
      {% endif %}
    </div>
    <pre><code class="hljs aiken">{{ function.signature }}</code></pre>
    <div class="rendered-markdown">{{ function.documentation|safe }}</div>
  </div>
  {% endfor %}
</section>
{% endif %}
{% endblock %}