IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Shorten verbose metadata comments in templates

Browse Source
This commit is contained in:
Adam Turner 2024-10-04 12:20:51 +01:00
parent dfa29f9d4a
commit 2bc662f0f8
22 changed files with 25 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sphinx/themes/agogo/layout.html
View File

@ -1,13 +1,4 @@
{# {# Sphinx layout template for the agogo theme. #}
agogo/layout.html
~~~~~~~~~~~~~~~~~
Sphinx layout template for the agogo theme, originally written
by Andi Albrecht.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "basic/layout.html" %} {%- extends "basic/layout.html" %}
{% block header %} {% block header %}

9
sphinx/themes/basic/defindex.html
View File

@ -1,11 +1,4 @@
{# {# Default template for the "index" page.
basic/defindex.html
~~~~~~~~~~~~~~~~~~~
Default template for the "index" page.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}{{ warn('Now base template defindex.html is deprecated.') }} #}{{ warn('Now base template defindex.html is deprecated.') }}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{% set title = _('Overview') %} {% set title = _('Overview') %}

10
sphinx/themes/basic/domainindex.html
View File

@ -1,12 +1,4 @@
{# {# Template for domain indices (module index, ...). #}
basic/domainindex.html
~~~~~~~~~~~~~~~~~~~~~~
Template for domain indices (module index, ...).
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{% set title = indextitle %} {% set title = indextitle %}
{% block extrahead %} {% block extrahead %}

10
sphinx/themes/basic/genindex-single.html
View File

@ -1,12 +1,4 @@
{# {# Template for a "single" page of a split index. #}
basic/genindex-single.html
~~~~~~~~~~~~~~~~~~~~~~~~~~
Template for a "single" page of a split index.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{% macro indexentries(firstname, links) %} {% macro indexentries(firstname, links) %}
{%- if links -%} {%- if links -%}
<a href="{{ links[0][1] }}"> <a href="{{ links[0][1] }}">

10
sphinx/themes/basic/genindex-split.html
View File

@ -1,12 +1,4 @@
{# {# Template for a "split" index overview page. #}
basic/genindex-split.html
~~~~~~~~~~~~~~~~~~~~~~~~~
Template for a "split" index overview page.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{% set title = _('Index') %} {% set title = _('Index') %}
{% block body %} {% block body %}

10
sphinx/themes/basic/genindex.html
View File

@ -1,12 +1,4 @@
{# {# Template for an "all-in-one" index. #}
basic/genindex.html
~~~~~~~~~~~~~~~~~~~
Template for an "all-in-one" index.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{% set title = _('Index') %} {% set title = _('Index') %}

10
sphinx/themes/basic/globaltoc.html
View File

@ -1,11 +1,3 @@
{# {# Sphinx sidebar template: global table of contents. #}
basic/globaltoc.html
~~~~~~~~~~~~~~~~~~~~
Sphinx sidebar template: global table of contents.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
<h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3> <h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3>
{{ toctree(includehidden=theme_globaltoc_includehidden, collapse=theme_globaltoc_collapse, maxdepth=theme_globaltoc_maxdepth) }} {{ toctree(includehidden=theme_globaltoc_includehidden, collapse=theme_globaltoc_collapse, maxdepth=theme_globaltoc_maxdepth) }}

10
sphinx/themes/basic/layout.html
View File

@ -1,12 +1,4 @@
{# {# Master layout template for Sphinx themes. #}
basic/layout.html
~~~~~~~~~~~~~~~~~
Master layout template for Sphinx themes.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- block doctype -%} {%- block doctype -%}
<!DOCTYPE html> <!DOCTYPE html>
{%- endblock %} {%- endblock %}

10
sphinx/themes/basic/localtoc.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx sidebar template: local table of contents. #}
basic/localtoc.html
~~~~~~~~~~~~~~~~~~~
Sphinx sidebar template: local table of contents.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- if display_toc %} {%- if display_toc %}
<div> <div>
<h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3> <h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3>

10
sphinx/themes/basic/page.html
View File

@ -1,12 +1,4 @@
{# {# Master template for simple pages. #}
basic/page.html
~~~~~~~~~~~~~~~
Master template for simple pages.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{% block body %} {% block body %}
{{ body }} {{ body }}

10
sphinx/themes/basic/relations.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx sidebar template: relation links. #}
basic/relations.html
~~~~~~~~~~~~~~~~~~~~
Sphinx sidebar template: relation links.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- if prev %} {%- if prev %}
<div> <div>
<h4>{{ _('Previous topic') }}</h4> <h4>{{ _('Previous topic') }}</h4>

10
sphinx/themes/basic/search.html
View File

@ -1,12 +1,4 @@
{# {# Template for the search page. #}
basic/search.html
~~~~~~~~~~~~~~~~~
Template for the search page.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{% set title = _('Search') %} {% set title = _('Search') %}
{%- block scripts %} {%- block scripts %}

10
sphinx/themes/basic/searchbox.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx sidebar template: quick search box. #}
basic/searchbox.html
~~~~~~~~~~~~~~~~~~~~
Sphinx sidebar template: quick search box.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- if pagename != "search" and builder != "singlehtml" %} {%- if pagename != "search" and builder != "singlehtml" %}
<search id="searchbox" style="display: none" role="search"> <search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">{{ _('Quick search') }}</h3> <h3 id="searchlabel">{{ _('Quick search') }}</h3>

14
sphinx/themes/basic/searchfield.html
View File

@ -1,14 +1,8 @@
{# {# Sphinx sidebar template: search field.
basic/searchfield.html
~~~~~~~~~~~~~~~~~~~~~~
Sphinx sidebar template: search field. This component is similar to searchbox.html but does not include an
This component is similar to searchbox.html but does not include an extra heading ("Quick search"). Instead, it uses a placeholder text
extra heading ("Quick search"). Instead, it uses a placeholder text in the search field.
in the search field.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#} #}
{%- if pagename != "search" and builder != "singlehtml" %} {%- if pagename != "search" and builder != "singlehtml" %}
<search id="searchbox" style="display: none" role="search"> <search id="searchbox" style="display: none" role="search">

10
sphinx/themes/basic/sourcelink.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx sidebar template: "show source" link. #}
basic/sourcelink.html
~~~~~~~~~~~~~~~~~~~~~
Sphinx sidebar template: "show source" link.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- if show_source and has_source and sourcename %} {%- if show_source and has_source and sourcename %}
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>{{ _('This Page') }}</h3> <h3>{{ _('This Page') }}</h3>

10
sphinx/themes/bizstyle/layout.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx layout template for the bizstyle theme. #}
bizstyle/layout.html
~~~~~~~~~~~~~~~~~~~~
Sphinx layout template for the bizstyle theme.
:copyright: Copyright 2007-2024 by Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{% extends "basic/layout.html" %} {% extends "basic/layout.html" %}
{%- block scripts %} {%- block scripts %}

10
sphinx/themes/classic/layout.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx layout template for the classic theme. #}
classic/layout.html
~~~~~~~~~~~~~~~~~~~
Sphinx layout template for the classic theme.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "basic/layout.html" %} {%- extends "basic/layout.html" %}
{%- block scripts %} {%- block scripts %}

10
sphinx/themes/epub/epub-cover.html
View File

@ -1,12 +1,4 @@
{# {# Sample template for the html cover page. #}
epub/epub-cover.html
~~~~~~~~~~~~~~~~~~~~
Sample template for the html cover page.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %} {%- extends "layout.html" %}
{%- block header %}{% endblock %} {%- block header %}{% endblock %}
{%- block rootrellink %}{% endblock %} {%- block rootrellink %}{% endblock %}

10
sphinx/themes/epub/layout.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx layout template for the epub theme. #}
epub/layout.html
~~~~~~~~~~~~~~~~
Sphinx layout template for the epub theme.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "basic/layout.html" %} {%- extends "basic/layout.html" %}
{%- block doctype -%} {%- block doctype -%}

10
sphinx/themes/haiku/layout.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx layout template for the haiku theme. #}
haiku/layout.html
~~~~~~~~~~~~~~~~~
Sphinx layout template for the haiku theme.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "basic/layout.html" %} {%- extends "basic/layout.html" %}
{# do not display relbars #} {# do not display relbars #}

10
sphinx/themes/nonav/layout.html
View File

@ -1,12 +1,4 @@
{# {# Sphinx layout template for the any help system theme. #}
nonav/layout.html
~~~~~~~~~~~~~~~~
Sphinx layout template for the any help system theme.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "basic/layout.html" %} {%- extends "basic/layout.html" %}
{%- block doctype -%} {%- block doctype -%}

11
sphinx/themes/scrolls/layout.html
View File

@ -1,13 +1,4 @@
{# {# Sphinx layout template for the scrolls theme. #}
scrolls/layout.html
~~~~~~~~~~~~~~~~~~~
Sphinx layout template for the scrolls theme, originally written
by Armin Ronacher.
:copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "basic/layout.html" %} {%- extends "basic/layout.html" %}
{%- block css %} {%- block css %}
{{ super() }} {{ super() }}