Merge branch 'master' into SIM113

sphinx-doc · Jan 1, 2023 · 9f3d18c · 9f3d18c
2 parents bff3eb2 + 0b1efd7
commit 9f3d18c
Show file tree

Hide file tree

Showing 52 changed files with 88 additions and 68 deletions.
diff --git a/.flake8 b/.flake8
@@ -19,9 +19,7 @@ ignore =
     SIM115,
     SIM117,
     SIM223,
-    SIM300,
     SIM401,
-    SIM904,
     SIM905,
     SIM907,
 exclude =

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -23,7 +23,7 @@ body:
         ``index.rst`` file, and for ``sphinx.ext.autodoc`` bugs, this should
         ideally be a single ``index.rst`` file, and a single example Python 
         module.
-      value: |
+      placeholder: |
         Minimal method (you can also paste the contents of ``index.rst`` and
         ``conf.py`` into this report):
         ```bash
@@ -50,24 +50,26 @@ body:
       value: |
         ## Environment info
 
-  - type: input
+  - type: textarea
     attributes:
       label: Environment Information
+      render: text
       description: >-
         Install the latest Sphinx 
         ``pip install -U "sphinx>=5.3"``
         then run ``sphinx-build --bug-report`` or ``python -m sphinx --bug-report``.
         and paste the output here.
     validations:
       required: true
-  - type: input
+  - type: textarea
     attributes:
       label: Sphinx extensions
+      render: python
       description: >-
         Attempt to reproduce your error with the smallest set of extensions possible.
         This makes it easier to determine where the problem you are encountering is.
         
-        e.g. ["sphinx.ext.autodoc", "recommonmark"]
+        e.g. ``["sphinx.ext.autodoc", "recommonmark"]``
     validations:
       required: false
   - type: textarea

diff --git a/LICENSE b/LICENSE
@@ -4,7 +4,7 @@ License for Sphinx
 Unless otherwise indicated, all code in the Sphinx project is licenced under the
 two clause BSD licence below.
 
-Copyright (c) 2007-2022 by the Sphinx team (see AUTHORS file).
+Copyright (c) 2007-2023 by the Sphinx team (see AUTHORS file).
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst
@@ -144,12 +144,12 @@ The following is a list of deprecated interfaces.
 
    * - ``favicon`` variable in HTML templates
      - 4.0
-     - TBD
+     - 6.0
      - ``favicon_url``
 
    * - ``logo`` variable in HTML templates
      - 4.0
-     - TBD
+     - 6.0
      - ``logo_url``
 
    * - ``sphinx.directives.patches.ListTable``

diff --git a/pyproject.toml b/pyproject.toml
@@ -62,7 +62,7 @@ dependencies = [
     "sphinxcontrib-serializinghtml>=1.1.5",
     "sphinxcontrib-qthelp",
     "Jinja2>=3.0",
-    "Pygments>=2.12",
+    "Pygments>=2.13",
     "docutils>=0.18,<0.20",
     "snowballstemmer>=2.0",
     "babel>=2.9",

diff --git a/sphinx/builders/epub3.py b/sphinx/builders/epub3.py
@@ -148,11 +148,11 @@ def navigation_doc_metadata(self, navlist: List[NavPoint]) -> Dict[str, Any]:
         """Create a dictionary with all metadata for the nav.xhtml file
         properly escaped.
         """
-        metadata = {}
-        metadata['lang'] = html.escape(self.config.epub_language)
-        metadata['toc_locale'] = html.escape(self.guide_titles['toc'])
-        metadata['navlist'] = navlist
-        return metadata
+        return {
+            'lang': html.escape(self.config.epub_language),
+            'toc_locale': html.escape(self.guide_titles['toc']),
+            'navlist': navlist
+        }
 
     def build_navigation_doc(self) -> None:
         """Write the metainfo file nav.xhtml."""

diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py
@@ -290,6 +290,7 @@ def _bug_report_info() -> int:
 
     import docutils
     import jinja2
+    import pygments
 
     print('Please paste all output below into the bug report template\n\n')
     print('```text')
@@ -299,6 +300,7 @@ def _bug_report_info() -> int:
     print(f'Sphinx version:        {sphinx.__display_version__}')
     print(f'Docutils version:      {docutils.__version__}')
     print(f'Jinja2 version:        {jinja2.__version__}')
+    print(f'Pygments version:      {pygments.__version__}')
     print('```')
     return 0
 

diff --git a/sphinx/templates/graphviz/graphviz.css b/sphinx/templates/graphviz/graphviz.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- graphviz extension.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/agogo/layout.html b/sphinx/themes/agogo/layout.html
@@ -5,7 +5,7 @@
     Sphinx layout template for the agogo theme, originally written
     by Andi Albrecht.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}

diff --git a/sphinx/themes/agogo/static/agogo.css_t b/sphinx/themes/agogo/static/agogo.css_t
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- agogo theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/basic/defindex.html b/sphinx/themes/basic/defindex.html
@@ -4,7 +4,7 @@
 
     Default template for the "index" page.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}{{ warn('Now base template defindex.html is deprecated.') }}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/basic/domainindex.html b/sphinx/themes/basic/domainindex.html
@@ -4,7 +4,7 @@
 
     Template for domain indices (module index, ...).
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/basic/genindex-single.html b/sphinx/themes/basic/genindex-single.html
@@ -4,7 +4,7 @@
 
     Template for a "single" page of a split index.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {% macro indexentries(firstname, links) %}

diff --git a/sphinx/themes/basic/genindex-split.html b/sphinx/themes/basic/genindex-split.html
@@ -4,7 +4,7 @@
 
     Template for a "split" index overview page.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/basic/genindex.html b/sphinx/themes/basic/genindex.html
@@ -4,7 +4,7 @@
 
     Template for an "all-in-one" index.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/basic/globaltoc.html b/sphinx/themes/basic/globaltoc.html
@@ -4,7 +4,7 @@
 
     Sphinx sidebar template: global table of contents.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 <h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3>

diff --git a/sphinx/themes/basic/layout.html b/sphinx/themes/basic/layout.html
@@ -4,7 +4,7 @@
 
     Master layout template for Sphinx themes.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- block doctype -%}{%- if html5_doctype %}

diff --git a/sphinx/themes/basic/localtoc.html b/sphinx/themes/basic/localtoc.html
@@ -4,7 +4,7 @@
 
     Sphinx sidebar template: local table of contents.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if display_toc %}

diff --git a/sphinx/themes/basic/page.html b/sphinx/themes/basic/page.html
@@ -4,7 +4,7 @@
 
     Master template for simple pages.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/basic/relations.html b/sphinx/themes/basic/relations.html
@@ -4,7 +4,7 @@
 
     Sphinx sidebar template: relation links.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if prev %}

diff --git a/sphinx/themes/basic/search.html b/sphinx/themes/basic/search.html
@@ -4,7 +4,7 @@
 
     Template for the search page.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/basic/searchbox.html b/sphinx/themes/basic/searchbox.html
@@ -4,7 +4,7 @@
 
     Sphinx sidebar template: quick search box.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if pagename != "search" and builder != "singlehtml" %}

diff --git a/sphinx/themes/basic/sourcelink.html b/sphinx/themes/basic/sourcelink.html
@@ -4,7 +4,7 @@
 
     Sphinx sidebar template: "show source" link.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if show_source and has_source and sourcename %}

diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/basic/static/doctools.js b/sphinx/themes/basic/static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/basic/static/language_data.js_t b/sphinx/themes/basic/static/language_data.js_t
@@ -5,7 +5,7 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/basic/static/searchtools.js b/sphinx/themes/basic/static/searchtools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/bizstyle/layout.html b/sphinx/themes/bizstyle/layout.html
@@ -4,7 +4,7 @@
 
     Sphinx layout template for the bizstyle theme.
 
-    :copyright: Copyright 2011-2014 by Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {% extends "basic/layout.html" %}

diff --git a/sphinx/themes/bizstyle/static/bizstyle.css_t b/sphinx/themes/bizstyle/static/bizstyle.css_t
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- business style theme.
  *
- * :copyright: Copyright 2011-2014 by Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/bizstyle/static/bizstyle.js_t b/sphinx/themes/bizstyle/static/bizstyle.js_t
@@ -6,7 +6,7 @@
 //
 // This theme was created by referring to 'sphinxdoc'
 //
-// :copyright: Copyright 2012-2014 by Sphinx team, see AUTHORS.
+// :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
 // :license: BSD, see LICENSE for details.
 //
 const initialiseBizStyle = () => {

diff --git a/sphinx/themes/classic/layout.html b/sphinx/themes/classic/layout.html
@@ -4,7 +4,7 @@
 
     Sphinx layout template for the classic theme.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}

diff --git a/sphinx/themes/classic/static/classic.css_t b/sphinx/themes/classic/static/classic.css_t
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- classic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/classic/static/sidebar.js_t b/sphinx/themes/classic/static/sidebar.js_t
@@ -16,7 +16,7 @@
  * Once the browser is closed the cookie is deleted and the position
  * reset to the default (expanded).
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/epub/epub-cover.html b/sphinx/themes/epub/epub-cover.html
@@ -4,7 +4,7 @@
 
     Sample template for the html cover page.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

diff --git a/sphinx/themes/epub/layout.html b/sphinx/themes/epub/layout.html
@@ -4,7 +4,7 @@
 
     Sphinx layout template for the epub theme.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}

diff --git a/sphinx/themes/epub/static/epub.css_t b/sphinx/themes/epub/static/epub.css_t
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- epub theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/sphinx/themes/haiku/layout.html b/sphinx/themes/haiku/layout.html
@@ -4,7 +4,7 @@
 
     Sphinx layout template for the haiku theme.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}

diff --git a/sphinx/themes/haiku/static/haiku.css_t b/sphinx/themes/haiku/static/haiku.css_t
@@ -16,7 +16,7 @@
  *              Braden Ewing <brewin@gmail.com>
  *              Humdinger <humdingerb@gmail.com>
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */