From 2bc662f0f83bd5bfffe14357c5013dc24efb6891 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Fri, 4 Oct 2024 12:20:51 +0100
Subject: [PATCH] Shorten verbose metadata comments in templates

---
 sphinx/themes/agogo/layout.html          | 11 +----------
 sphinx/themes/basic/defindex.html        |  9 +--------
 sphinx/themes/basic/domainindex.html     | 10 +---------
 sphinx/themes/basic/genindex-single.html | 10 +---------
 sphinx/themes/basic/genindex-split.html  | 10 +---------
 sphinx/themes/basic/genindex.html        | 10 +---------
 sphinx/themes/basic/globaltoc.html       | 10 +---------
 sphinx/themes/basic/layout.html          | 10 +---------
 sphinx/themes/basic/localtoc.html        | 10 +---------
 sphinx/themes/basic/page.html            | 10 +---------
 sphinx/themes/basic/relations.html       | 10 +---------
 sphinx/themes/basic/search.html          | 10 +---------
 sphinx/themes/basic/searchbox.html       | 10 +---------
 sphinx/themes/basic/searchfield.html     | 14 ++++----------
 sphinx/themes/basic/sourcelink.html      | 10 +---------
 sphinx/themes/bizstyle/layout.html       | 10 +---------
 sphinx/themes/classic/layout.html        | 10 +---------
 sphinx/themes/epub/epub-cover.html       | 10 +---------
 sphinx/themes/epub/layout.html           | 10 +---------
 sphinx/themes/haiku/layout.html          | 10 +---------
 sphinx/themes/nonav/layout.html          | 10 +---------
 sphinx/themes/scrolls/layout.html        | 11 +----------
 22 files changed, 25 insertions(+), 200 deletions(-)

diff --git a/sphinx/themes/agogo/layout.html b/sphinx/themes/agogo/layout.html
index 9f5fabf3e..92b7c41d4 100644
--- a/sphinx/themes/agogo/layout.html
+++ b/sphinx/themes/agogo/layout.html
@@ -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 %}
diff --git a/sphinx/themes/basic/defindex.html b/sphinx/themes/basic/defindex.html
index c614b69aa..f27e5ccf5 100644
--- a/sphinx/themes/basic/defindex.html
+++ b/sphinx/themes/basic/defindex.html
@@ -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') %}
diff --git a/sphinx/themes/basic/domainindex.html b/sphinx/themes/basic/domainindex.html
index 25d7e3002..f8e3305cd 100644
--- a/sphinx/themes/basic/domainindex.html
+++ b/sphinx/themes/basic/domainindex.html
@@ -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 %}
diff --git a/sphinx/themes/basic/genindex-single.html b/sphinx/themes/basic/genindex-single.html
index 79464dad6..af9741490 100644
--- a/sphinx/themes/basic/genindex-single.html
+++ b/sphinx/themes/basic/genindex-single.html
@@ -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] }}">
diff --git a/sphinx/themes/basic/genindex-split.html b/sphinx/themes/basic/genindex-split.html
index 5375365e2..c2a10dec4 100644
--- a/sphinx/themes/basic/genindex-split.html
+++ b/sphinx/themes/basic/genindex-split.html
@@ -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 %}
diff --git a/sphinx/themes/basic/genindex.html b/sphinx/themes/basic/genindex.html
index b62a9c3db..c39b7493e 100644
--- a/sphinx/themes/basic/genindex.html
+++ b/sphinx/themes/basic/genindex.html
@@ -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') %}
 
diff --git a/sphinx/themes/basic/globaltoc.html b/sphinx/themes/basic/globaltoc.html
index 9745538f2..d91736226 100644
--- a/sphinx/themes/basic/globaltoc.html
+++ b/sphinx/themes/basic/globaltoc.html
@@ -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) }}
diff --git a/sphinx/themes/basic/layout.html b/sphinx/themes/basic/layout.html
index b438b919b..470e71d7d 100644
--- a/sphinx/themes/basic/layout.html
+++ b/sphinx/themes/basic/layout.html
@@ -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 %}
diff --git a/sphinx/themes/basic/localtoc.html b/sphinx/themes/basic/localtoc.html
index 70f3e160b..ddebfebae 100644
--- a/sphinx/themes/basic/localtoc.html
+++ b/sphinx/themes/basic/localtoc.html
@@ -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>
diff --git a/sphinx/themes/basic/page.html b/sphinx/themes/basic/page.html
index 502278e7f..19a1c876e 100644
--- a/sphinx/themes/basic/page.html
+++ b/sphinx/themes/basic/page.html
@@ -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 }}
diff --git a/sphinx/themes/basic/relations.html b/sphinx/themes/basic/relations.html
index 7ce494f34..f142688bb 100644
--- a/sphinx/themes/basic/relations.html
+++ b/sphinx/themes/basic/relations.html
@@ -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>
diff --git a/sphinx/themes/basic/search.html b/sphinx/themes/basic/search.html
index 8bad82a51..0ce54c434 100644
--- a/sphinx/themes/basic/search.html
+++ b/sphinx/themes/basic/search.html
@@ -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 %}
diff --git a/sphinx/themes/basic/searchbox.html b/sphinx/themes/basic/searchbox.html
index 1f084bb92..e0045b4de 100644
--- a/sphinx/themes/basic/searchbox.html
+++ b/sphinx/themes/basic/searchbox.html
@@ -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>
diff --git a/sphinx/themes/basic/searchfield.html b/sphinx/themes/basic/searchfield.html
index 396218ff5..cffde75a8 100644
--- a/sphinx/themes/basic/searchfield.html
+++ b/sphinx/themes/basic/searchfield.html
@@ -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">
diff --git a/sphinx/themes/basic/sourcelink.html b/sphinx/themes/basic/sourcelink.html
index 72a59666d..14bf7cad4 100644
--- a/sphinx/themes/basic/sourcelink.html
+++ b/sphinx/themes/basic/sourcelink.html
@@ -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>
diff --git a/sphinx/themes/bizstyle/layout.html b/sphinx/themes/bizstyle/layout.html
index 226c7878d..a19309056 100644
--- a/sphinx/themes/bizstyle/layout.html
+++ b/sphinx/themes/bizstyle/layout.html
@@ -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 %}
diff --git a/sphinx/themes/classic/layout.html b/sphinx/themes/classic/layout.html
index 99a101c96..d2fc9270e 100644
--- a/sphinx/themes/classic/layout.html
+++ b/sphinx/themes/classic/layout.html
@@ -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 %}
diff --git a/sphinx/themes/epub/epub-cover.html b/sphinx/themes/epub/epub-cover.html
index 15d46161b..5682f262e 100644
--- a/sphinx/themes/epub/epub-cover.html
+++ b/sphinx/themes/epub/epub-cover.html
@@ -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 %}
diff --git a/sphinx/themes/epub/layout.html b/sphinx/themes/epub/layout.html
index c7b63cd81..2938d0b3c 100644
--- a/sphinx/themes/epub/layout.html
+++ b/sphinx/themes/epub/layout.html
@@ -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 -%}
diff --git a/sphinx/themes/haiku/layout.html b/sphinx/themes/haiku/layout.html
index b23937fbb..0c13802c1 100644
--- a/sphinx/themes/haiku/layout.html
+++ b/sphinx/themes/haiku/layout.html
@@ -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 #}
diff --git a/sphinx/themes/nonav/layout.html b/sphinx/themes/nonav/layout.html
index ba5f7b746..f61ef1436 100644
--- a/sphinx/themes/nonav/layout.html
+++ b/sphinx/themes/nonav/layout.html
@@ -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 -%}
diff --git a/sphinx/themes/scrolls/layout.html b/sphinx/themes/scrolls/layout.html
index 8a0db7d12..a0a5e0465 100644
--- a/sphinx/themes/scrolls/layout.html
+++ b/sphinx/themes/scrolls/layout.html
@@ -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() }}