1. Georg Brandl
  2. sphinx

Source

sphinx / sphinx / templates / layout.html

{% if builder != 'htmlhelp' %}{% set titlesuffix = " — " + project + " Documentation" %}{% endif -%}
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>{{ title|striptags }}{{ titlesuffix }}</title>
    {%- if builder == 'web' %}
    <link rel="stylesheet" href="{{ pathto('index') }}?do=stylesheet{%
      if in_admin_panel %}&admin=yes{% endif %}" type="text/css">
    {%- for link, type, title in page_links %}
    <link rel="alternate" type="{{ type|e(true) }}" title="{{ title|e(true) }}" href="{{ link|e(true) }}">
    {%- endfor %}
    {%- else %}
    <link rel="stylesheet" href="{{ pathto('style/default.css', 1) }}" type="text/css">
    <link rel="stylesheet" href="{{ pathto('style/pygments.css', 1) }}" type="text/css">
    {%- endif %}
    {%- if builder != 'htmlhelp' %}
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:   '{{ pathto("", 1) }}',
        VERSION:    '{{ release }}'
      };
    </script>
    <script type="text/javascript" src="{{ pathto('style/jquery.js', 1) }}"></script>
    <script type="text/javascript" src="{{ pathto('style/interface.js', 1) }}"></script>
    <script type="text/javascript" src="{{ pathto('style/doctools.js', 1) }}"></script>
    {%- endif %}
    {%- if hasdoc('about') %}
    <link rel="author" title="About these documents" href="{{ pathto('about') }}">
    {%- endif %}
    <link rel="contents" title="Global table of contents" href="{{ pathto('contents') }}">
    <link rel="index" title="Global index" href="{{ pathto('genindex') }}">
    <link rel="search" title="Search" href="{{ pathto('search') }}">
    {%- if hasdoc('copyright') %}
    <link rel="copyright" title="Copyright" href="{{ pathto('copyright') }}">
    {%- endif %}
    <link rel="top" title="{{ project }} Documentation" href="{{ pathto('index') }}">
    {%- if parents %}
    <link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}">
    {%- endif %}
    {%- if next %}
    <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}">
    {%- endif %}
    {%- if prev %}
    <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}">
    {%- endif %}
    {% block head %}{% endblock %}
  </head>
  <body>
{% filter capture('relbar') %}
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px"><a href="{{ pathto('genindex') }}" title="General Index" accesskey="I">index</a></li>
        <li class="right"><a href="{{ pathto('modindex') }}" title="Global Module Index" accesskey="M">modules</a> |</li>
        {%- if next %}
          <li class="right"><a href="{{ next.link|e }}" title="{{ next.title|striptags }}" accesskey="N">next</a> |</li>
        {%- endif %}
        {%- if prev %}
          <li class="right"><a href="{{ prev.link|e }}" title="{{ prev.title|striptags }}" accesskey="P">previous</a> |</li>
        {%- endif %}
        {%- if builder == 'web' %}
          <li class="right"><a href="{{ pathto('settings') }}"
                               title="Customize your viewing settings" accesskey="S">settings</a> |</li>
        {%- endif %}
        <li><a href="{{ pathto('index') }}">{{ project }} v{{ release }} Documentation</a> &raquo;</li>
        {%- for parent in parents %}
          <li><a href="{{ parent.link|e }}" accesskey="U">{{ parent.title }}</a> &raquo;</li>
        {%- endfor %}
      </ul>
    </div>
{% endfilter %}
    <div class="document">
      <div class="documentwrapper">
      {%- if builder != 'htmlhelp' %}
        <div class="bodywrapper">
      {%- endif %}
          <div class="body">
            {% block body %}{% endblock %}
          </div>
      {%- if builder != 'htmlhelp' %}
        </div>
      {%- endif %}
      </div>
      {%- if builder != 'htmlhelp' %}
      <div class="sidebar">
        <div class="sidebarwrapper">
          {% if display_toc %}
            <h3>Table Of Contents</h3>
            {{ toc }}
          {% endif %}
          {%- if prev %}
            <h4>Previous topic</h4>
            <p class="topless"><a href="{{ prev.link|e }}" title="previous chapter">{{ prev.title }}</a></p>
          {%- endif %}
          {%- if next %}
            <h4>Next topic</h4>
            <p class="topless"><a href="{{ next.link|e }}" title="next chapter">{{ next.title }}</a></p>
          {%- endif %}
          {% if sourcename %}
            <h3>This Page</h3>
            <ul class="this-page-menu">
            {% if builder == 'web' %}
              <li><a href="#comments">Comments ({{ comments|length }} so far)</a></li>
              <li><a href="{{ pathto('@edit/' + sourcename)|e }}">Suggest Change</a></li>
              <li><a href="{{ pathto('@source/' + sourcename)|e }}">Show Source</a></li>
            {% elif builder == 'html' %}
              <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}">Show Source</a></li>
            {% endif %}
            </ul>
          {% endif %}
          {% if customsidebar %}
          {{ rendertemplate(customsidebar) }}
          {% endif %}
          {% if current_page_name != "search" and builder == 'web' %}
          {# HTML builder search is disabled for now #}
            <h3>{{ builder == 'web' and 'Keyword' or 'Quick' }} search</h3>
            <form class="search" action="{{ pathto('search') }}" method="get">
              <input type="text" name="q" size="18"> <input type="submit" value="Go">
              <input type="hidden" name="check_keywords" value="yes">
              <input type="hidden" name="area" value="default">
            </form>
            {% if builder == 'web' %}
            <p style="font-size: 90%">Enter a module, class or function name.</p>
            {% endif %}
          {% endif %}
        </div>
      </div>
      {%- endif %}
      <div class="clearer"></div>
    </div>
{{ relbar }}
    <div class="footer">
    {%- if hasdoc('copyright') %}
      &copy; <a href="{{ pathto('copyright') }}">Copyright</a> {{ copyright }}.
    {%- else %}
      &copy; Copyright {{ copyright }}.
    {%- endif %}
    {%- if last_updated %}
      Last updated on {{ last_updated }}.
    {%- endif %}
    </div>
  </body>
</html>