view doc/_templates/layout.html @ 8255:7d72b9a9fe9c

docs: doc new types in user_guide; alphabetize types in reference. user_guide.txt: Removed Number from String and Number Properties. Added new Integer and Number Properties sections to the user guide. Number Proprty formats defined: no thousand separators, '.' decimal separator, supports scientific 2E4 style input. Ordered in rough order of use. reference.txt: Alphabetized the types in the reference manual for easy lookup. Fixed sentence on quiet property.
author John Rouillard <rouilj@ieee.org>
date Wed, 01 Jan 2025 15:48:01 -0500
parents 7ac637506acf
children 63665d93940b
line wrap: on
line source

{% set script_files = ['_static/jquery.js', '_static/doctools.js',
                       '_static/language_data.js',
                       '_static/searchtools.js',
                       '_static/sphinx_highlight.js',
                       '_static/tabs.js',
] %}
{#
    _templates/layout.html
    ~~~~~~~~~~~~~~~~~~~~~~

    Custom layout template for Roundup.

#}
{%- block doctype -%}
<!DOCTYPE html>
{%- endblock %}
{%- macro relbar(class) %}
    <div class="related {{ class }}">
      <ul>
        {%- for rellink in rellinks %}
        <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
          <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}"
             accesskey="{{ rellink[2] }}">{{ rellink[3] }}</a>
          {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
        {%- endfor %}
        {%- block rootrellink %}
        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
        {%- endblock %}
        {%- for parent in parents %}
          <li><a href="{{ parent.link|e }}" accesskey="U">{{ parent.title }}</a>{{ reldelim1 }}</li>
        {%- endfor %}
        {%- block relbaritems %} {% endblock %}
      </ul>
    </div>
{%- endmacro %}
{%- macro sidebar() %}
  {%- block sidebartoc %}
  {%- if display_toc %}
    <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
    {{ toc }}
  {%- endif %}
  {%- endblock %}
  {%- block sidebarrel %}
  {%- 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 %}
  {%- endblock %}
  {%- block sidebarsourcelink %}
  {%- if show_source and has_source and sourcename %}
    <h3>{{ _('This Page') }}</h3>
    <ul class="this-page-menu">
      <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
             rel="nofollow">{{ _('Show Source') }}</a></li>
    </ul>
  {%- endif %}
  {%- endblock %}
  {%- block sidebarsearch %}
  {%- if pagename != "search" %}
  <div id="searchbox" style="display: none">
    <h3>{{ _('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>
      <p style="font-size: 90%">{{ _('Enter search terms or a module, class or function name.') }}</p>
  </div>
  <script type="text/javascript">$('#searchbox').show(0);</script>
  {%- endif %}
  {%- endblock %}
{%- endmacro %}

{%- macro css() %}
    <link rel="stylesheet" href="{{ pathto('_static/NO_basic.css', 1) }}" type="text/css" />
    <link rel="stylesheet" href="{{ pathto('_static/' + styles[-1], 1) }}" type="text/css" />
    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
    {%- for cssfile in css_files %}
    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
    {%- endfor %}
{%- endmacro %}

{#
 In newer sphinx styles is an array and style does not exist
 In older sphinx (1.x) style is the style set in conf.py.

 If style exists, assume styles doesn't exist and make styles
 exist with style as the only value.

 So we can use styles[-1] in the css() macro.
 When sourceforge lets me build docs with something newer than sphinx 1,
 we can delete this.
#}
{% if style %}
{% set styles = [] %}
{{ styles.append( style ) }}
{% endif %}

<html lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    {%- if builder != 'htmlhelp' %}
      {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
    {%- endif %}
    <title>{{ title|striptags }}{{ titlesuffix }}</title>
    {%- if builder != 'htmlhelp' %}
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    '{{ pathto("", 1) }}',
          VERSION:     '{{ release|e }}',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: '{{ file_suffix }}'
      };
    </script>
    {%- for scriptfile in script_files %}
    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
    {%- endfor %}
    {%- 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 %}
    {{ css() }}
    {%- endif %}
    <!-- https://github.com/sphinx-doc/sphinx/issues/11699 means a
         duplicate viewport tag -->
    {{ metatags }}
    {%- if 'name="description"' not in metatags %}
      <meta name="description"
        content="Page {{ pagename }} in documentation on the Roundup issue tracker, version {{ release|e }}.">
    {%- endif %}
    {%- if use_opensearch %}
    <link rel="search" type="application/opensearchdescription+xml"
          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
    {%- endif %}
    {%- if favicon %}
    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
    {%- endif %}
    {%- endif %}
{%- block linktags %}
    {%- if hasdoc('about') %}
    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
    {%- endif %}
    <link rel="index" title="{{ _('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="{{ docstitle|e }}" 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 %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
  </head>
  <body>
    <div class="header"><div class="label">Roundup</div>
      {%- if pagename != "search" %}
        <script id="documentation_options" data-url_root="{{ url_root }}"
	      src="{{ pathto('_static/documentation_options.js', 1) }}">
        </script>

        <div id="searchbox" style="display: none">
          <form class="search" action="{{ pathto('search') }}" method="get">
            <input type="text" name="q" size="18" />
            <input type="submit" value="{{ _('Search') }}" />
            <input type="hidden" name="check_keywords" value="yes" />
            <input type="hidden" name="area" value="default" />
          </form>
        </div>
        <script type="text/javascript">$('#searchbox').show(0);</script>
      {%- endif %}
    </div>
    <div class="navigation">
      <div class="menu">
       {{ sidebar() }}
      </div>
    </div>
{%- block content %}
    <main id="main" role="main" class="content">
       {{ relbar('related-top') }}
       {% block body %} {% endblock %}
       {{ relbar('related-bottom') }}
    </main>
  {%- endblock %}
{%- block footer %}
    <div class="footer">
      {%- if hasdoc('copyright') %}
        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
      {%- else %}
        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
      {%- endif %}
    </div>
{%- endblock %}
  </body>
</html>

Roundup Issue Tracker: http://roundup-tracker.org/