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 @@
{#
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.
#}
{# Sphinx layout template for the agogo theme. #}
{%- extends "basic/layout.html" %}
{% block header %}

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

@ -1,11 +1,4 @@
{#
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.
{# Default template for the "index" page.
#}{{ warn('Now base template defindex.html is deprecated.') }}
{%- extends "layout.html" %}
{% set title = _('Overview') %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Template for domain indices (module index, ...). #}
{%- extends "layout.html" %}
{% set title = indextitle %}
{% block extrahead %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Template for a "single" page of a split index. #}
{% macro indexentries(firstname, links) %}
{%- if links -%}
<a href="{{ links[0][1] }}">

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Template for a "split" index overview page. #}
{%- extends "layout.html" %}
{% set title = _('Index') %}
{% block body %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Template for an "all-in-one" index. #}
{%- extends "layout.html" %}
{% set title = _('Index') %}

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

@ -1,11 +1,3 @@
{#
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.
#}
{# Sphinx sidebar template: global table of contents. #}
<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) }}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Master layout template for Sphinx themes. #}
{%- block doctype -%}
<!DOCTYPE html>
{%- endblock %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx sidebar template: local table of contents. #}
{%- if display_toc %}
<div>
<h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3>

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

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

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

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

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

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

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx sidebar template: quick search box. #}
{%- if pagename != "search" and builder != "singlehtml" %}
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">{{ _('Quick search') }}</h3>

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

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

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx sidebar template: "show source" link. #}
{%- if show_source and has_source and sourcename %}
<div role="note" aria-label="source link">
<h3>{{ _('This Page') }}</h3>

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx layout template for the bizstyle theme. #}
{% extends "basic/layout.html" %}
{%- block scripts %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx layout template for the classic theme. #}
{%- extends "basic/layout.html" %}
{%- block scripts %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sample template for the html cover page. #}
{%- extends "layout.html" %}
{%- block header %}{% endblock %}
{%- block rootrellink %}{% endblock %}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx layout template for the epub theme. #}
{%- extends "basic/layout.html" %}
{%- block doctype -%}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx layout template for the haiku theme. #}
{%- extends "basic/layout.html" %}
{# do not display relbars #}

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

@ -1,12 +1,4 @@
{#
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.
#}
{# Sphinx layout template for the any help system theme. #}
{%- extends "basic/layout.html" %}
{%- block doctype -%}

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

@ -1,13 +1,4 @@
{#
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.
#}
{# Sphinx layout template for the scrolls theme. #}
{%- extends "basic/layout.html" %}
{%- block css %}
{{ super() }}