kr.motd.maven.sphinx.dist.sphinx.themes.basic.layout.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sphinx-maven-plugin Show documentation
Maven plugin that creates the site with Sphinx
There is a newer version: 2.10.0
{#
    basic/layout.html
    ~~~~~~~~~~~~~~~~~

    Master layout template for Sphinx themes.

    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
#}
{%- block doctype -%}

{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
                         (sidebars != []) %}
{%- set url_root = pathto('', 1) %}
{# XXX necessary? #}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
  {%- set titlesuffix = " — "|safe + docstitle|e %}
{%- else %}
  {%- set titlesuffix = "" %}
{%- endif %}

{%- macro relbar() %}
    
      {{ _('Navigation') }}
      
        {%- for rellink in rellinks %}
        
          {{ rellink[3] }}
          {%- if not loop.first %}{{ reldelim2 }}{% endif %}
        {%- endfor %}
        {%- block rootrellink %}
        {{ shorttitle|e }}{{ reldelim1 }}
        {%- endblock %}
        {%- for parent in parents %}
          {{ parent.title }}{{ reldelim1 }}
        {%- endfor %}
        {%- block relbaritems %} {% endblock %}
      
    
{%- endmacro %}

{%- macro sidebar() %}
      {%- if render_sidebar %}
      
        
          {%- block sidebarlogo %}
          {%- if logo %}
            
              
            
          {%- endif %}
          {%- endblock %}
          {%- if sidebars != None %}
            {#- new style sidebar: explicitly include/exclude templates #}
            {%- for sidebartemplate in sidebars %}
            {%- include sidebartemplate %}
            {%- endfor %}
          {%- else %}
            {#- old style sidebars: using blocks -- should be deprecated #}
            {%- block sidebartoc %}
            {%- include "localtoc.html" %}
            {%- endblock %}
            {%- block sidebarrel %}
            {%- include "relations.html" %}
            {%- endblock %}
            {%- block sidebarsourcelink %}
            {%- include "sourcelink.html" %}
            {%- endblock %}
            {%- if customsidebar %}
            {%- include customsidebar %}
            {%- endif %}
            {%- block sidebarsearch %}
            {%- include "searchbox.html" %}
            {%- endblock %}
          {%- endif %}
        
      
      {%- endif %}
{%- endmacro %}

{%- macro script() %}
    
    {%- for scriptfile in script_files %}
    
    {%- endfor %}
{%- endmacro %}

{%- macro css() %}
    
    
    {%- for cssfile in css_files %}
    
    {%- endfor %}
{%- endmacro %}


  
    
    {{ metatags }}
    {%- block htmltitle %}
    {{ title|striptags|e }}{{ titlesuffix }}
    {%- endblock %}
    {{ css() }}
    {%- if not embedded %}
    {{ script() }}
    {%- if use_opensearch %}
    
    {%- endif %}
    {%- if favicon %}
    
    {%- endif %}
    {%- endif %}
{%- block linktags %}
    {%- if hasdoc('about') %}
    
    {%- endif %}
    {%- if hasdoc('genindex') %}
    
    {%- endif %}
    {%- if hasdoc('search') %}
    
    {%- endif %}
    {%- if hasdoc('copyright') %}
    
    {%- endif %}
    
    {%- if parents %}
    
    {%- endif %}
    {%- if next %}
    
    {%- endif %}
    {%- if prev %}
    
    {%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
  
  
{%- block header %}{% endblock %}

{%- block relbar1 %}{{ relbar() }}{% endblock %}

{%- block content %}
  {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}

    
  {%- block document %}
      
      {%- if render_sidebar %}
        
      {%- endif %}
          
            {% block body %} {% endblock %}
          
      {%- if render_sidebar %}
        
      {%- endif %}
      
  {%- endblock %}

  {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
      
    
{%- endblock %}

{%- block relbar2 %}{{ relbar() }}{% endblock %}

{%- block footer %}
    
    {%- if show_copyright %}
      {%- if hasdoc('copyright') %}
        {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
      {%- else %}
        {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
      {%- endif %}
    {%- endif %}
    {%- if last_updated %}
      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
    {%- endif %}
    {%- if show_sphinx %}
      {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %}
    {%- endif %}
    
{%- endblock %}