Sphinx 8.0.2__py3-none-any.whl → 8.1.0__py3-none-any.whl

sphinx/themes/basic/static/doctools.js

@@ -1,12 +1,5 @@
 /*
- * doctools.js
- * ~~~~~~~~~~~
- *
  * Base JavaScript utilities for all Sphinx HTML documentation.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 

sphinx/themes/basic/static/language_data.js.jinja

@@ -1,13 +1,6 @@
 /*
- * language_data.js
- * ~~~~~~~~~~~~~~~~
- *
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 var stopwords = {{ search_language_stop_words }};

sphinx/themes/basic/static/searchtools.js

@@ -1,12 +1,5 @@
 /*
- * searchtools.js
- * ~~~~~~~~~~~~~~~~
- *
  * Sphinx JavaScript utilities for the full-text search.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 
@@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") {
     // and returns the new score.
     /*
     score: result => {
-      const [docname, title, anchor, descr, score, filename] = result
+      const [docname, title, anchor, descr, score, filename, kind] = result
       return score
     },
     */
@@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") {
   };
 }
 
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+    static get index() { return  "index"; }
+    static get object() { return "object"; }
+    static get text() { return "text"; }
+    static get title() { return "title"; }
+}
+
 const _removeChildren = (element) => {
   while (element && element.lastChild) element.removeChild(element.lastChild);
 };
@@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
   const contentRoot = document.documentElement.dataset.content_root;
 
-  const [docName, title, anchor, descr, score, _filename] = item;
+  const [docName, title, anchor, descr, score, _filename, kind] = item;
 
   let listItem = document.createElement("li");
+  // Add a class representing the item's type:
+  // can be used by a theme's CSS selector for styling
+  // See SearchResultKind for the class names.
+  listItem.classList.add(`kind-${kind}`);
   let requestUrl;
   let linkUrl;
   if (docBuilder === "dirhtml") {
@@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => {
       "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
     );
   else
-    Search.status.innerText = _(
-      "Search finished, found ${resultCount} page(s) matching the search query."
+    Search.status.innerText = Documentation.ngettext(
+      "Search finished, found one page matching the search query.",
+      "Search finished, found ${resultCount} pages matching the search query.",
+      resultCount,
     ).replace('${resultCount}', resultCount);
 };
 const _displayNextItem = (
@@ -138,7 +145,7 @@ const _displayNextItem = (
   else _finishSearch(resultCount);
 };
 // Helper function used by query() to order search results.
-// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
 // Order the results by score (in opposite order of appearance, since the
 // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
 const _orderResultsByScoreThenName = (a, b) => {
@@ -248,6 +255,7 @@ const Search = {
     searchSummary.classList.add("search-summary");
     searchSummary.innerText = "";
     const searchList = document.createElement("ul");
+    searchList.setAttribute("role", "list");
     searchList.classList.add("search");
 
     const out = document.getElementById("search-results");
@@ -318,7 +326,7 @@ const Search = {
     const indexEntries = Search._index.indexentries;
 
     // Collect multiple result groups to be sorted separately and then ordered.
-    // Each is an array of [docname, title, anchor, descr, score, filename].
+    // Each is an array of [docname, title, anchor, descr, score, filename, kind].
     const normalResults = [];
     const nonMainIndexResults = [];
 
@@ -337,6 +345,7 @@ const Search = {
             null,
             score + boost,
             filenames[file],
+            SearchResultKind.title,
           ]);
         }
       }
@@ -354,6 +363,7 @@ const Search = {
             null,
             score,
             filenames[file],
+            SearchResultKind.index,
           ];
           if (isMain) {
             normalResults.push(result);
@@ -475,6 +485,7 @@ const Search = {
         descr,
         score,
         filenames[match[0]],
+        SearchResultKind.object,
       ]);
     };
     Object.keys(objects).forEach((prefix) =>
@@ -585,6 +596,7 @@ const Search = {
         null,
         score,
         filenames[file],
+        SearchResultKind.text,
       ]);
     }
     return results;

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 %}

sphinx/themes/bizstyle/static/bizstyle.css.jinja

@@ -1,12 +1,5 @@
 /*
- * bizstyle.css_t
- * ~~~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- business style theme.
- *
- * :copyright: Copyright 2007-2024 by Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 @import url("basic.css");

sphinx/themes/bizstyle/static/bizstyle.js.jinja

@@ -1,14 +1,8 @@
-//
-// bizstyle.js
-// ~~~~~~~~~~~
-//
-// Sphinx javascript -- for bizstyle theme.
-//
-// This theme was created by referring to 'sphinxdoc'
-//
-// :copyright: Copyright 2007-2024 by Sphinx team, see AUTHORS.
-// :license: BSD, see LICENSE for details.
-//
+/*
+ * Sphinx javascript -- for bizstyle theme.
+ *
+ * This theme was created by referring to 'sphinxdoc'
+ */
 const initialiseBizStyle = () => {
     if (navigator.userAgent.indexOf("iPhone") > 0 || navigator.userAgent.indexOf("Android") > 0) {
         document.querySelector("li.nav-item-0 a").innerText = "Top"

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 %}

sphinx/themes/classic/static/classic.css.jinja

@@ -1,12 +1,5 @@
 /*
- * classic.css_t
- * ~~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- classic theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 @import url("basic.css");

sphinx/themes/classic/static/sidebar.js.jinja

@@ -1,7 +1,4 @@
 /*
- * sidebar.js
- * ~~~~~~~~~~
- *
  * This script makes the Sphinx sidebar collapsible.
  *
  * .sphinxsidebar contains .sphinxsidebarwrapper.  This script adds
@@ -16,9 +13,6 @@
  * Once the browser is closed the cookie is deleted and the position
  * reset to the default (expanded).
  *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 const initialiseSidebar = () => {

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 %}

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 -%}

sphinx/themes/epub/static/epub.css.jinja

@@ -1,12 +1,5 @@
 /*
- * epub.css_t
- * ~~~~~~~~~~
- *
  * Sphinx stylesheet -- epub theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 /* -- main layout ----------------------------------------------------------- */

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 #}

sphinx/themes/haiku/static/haiku.css.jinja

@@ -1,7 +1,4 @@
 /*
- * haiku.css_t
- * ~~~~~~~~~~~
- *
  * Sphinx stylesheet -- haiku theme.
  *
  * Adapted from https://haiku-os.org/docs/Haiku-doc.css.
@@ -16,9 +13,6 @@
  *              Braden Ewing <brewin@gmail.com>
  *              Humdinger <humdingerb@gmail.com>
  *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 @import url("basic.css");

sphinx/themes/nature/static/nature.css.jinja

@@ -1,12 +1,5 @@
 /*
- * nature.css_t
- * ~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- nature theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 @import url("basic.css");

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 -%}

sphinx/themes/nonav/static/nonav.css.jinja

@@ -1,12 +1,5 @@
 /*
- * nonav.css
- * ~~~~~~~~~~
- *
  * Sphinx stylesheet -- nonav theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 /* -- main layout ----------------------------------------------------------- */

sphinx/themes/pyramid/static/epub.css.jinja

@@ -1,12 +1,5 @@
 /*
- * default.css_t
- * ~~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- default theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 @import url("basic.css");

sphinx/themes/pyramid/static/pyramid.css.jinja

@@ -1,12 +1,5 @@
 /*
- * pyramid.css_t
- * ~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- pylons theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 @import url("basic.css");

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() }}

sphinx/themes/scrolls/static/scrolls.css.jinja

@@ -1,12 +1,5 @@
 /*
- * scrolls.css_t
- * ~~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- scrolls theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 body {

sphinx/themes/sphinxdoc/static/sphinxdoc.css.jinja

@@ -1,12 +1,7 @@
 /*
- * sphinxdoc.css_t
- * ~~~~~~~~~~~~~~~
+ * Sphinx stylesheet -- sphinxdoc theme.
  *
- * Sphinx stylesheet -- sphinxdoc theme.  Originally created by
- * Armin Ronacher for Werkzeug.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
+ * Originally created by Armin Ronacher for Werkzeug.
  *
  */
 

sphinx/themes/traditional/static/traditional.css.jinja

@@ -1,12 +1,5 @@
 /*
- * traditional.css
- * ~~~~~~~~~~~~~~~
- *
  * Sphinx stylesheet -- traditional docs.python.org theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 body {

sphinx/theming.py

@@ -293,7 +293,9 @@ def _load_theme_with_ancestors(
     return themes, theme_dirs, tmp_dirs
 
 
-def _load_theme(name: str, theme_path: str, /) -> tuple[str, str, str | None, _ConfigFile]:
+def _load_theme(
+    name: str, theme_path: str, /
+) -> tuple[str, str, str | None, _ConfigFile]:
     if path.isdir(theme_path):
         # already a directory, do nothing
         tmp_dir = None
@@ -371,7 +373,9 @@ def _convert_theme_toml(cfg: _ThemeToml, /) -> _ConfigFile:
     pygments_table = theme.get('pygments_style', {})
     if isinstance(pygments_table, str):
         hint = f'pygments_style = {{ default = "{pygments_table}" }}'
-        msg = __('The "theme.pygments_style" setting must be a table. Hint: "%s"') % hint
+        msg = (
+            __('The "theme.pygments_style" setting must be a table. Hint: "%s"') % hint
+        )
         raise ThemeError(msg)
     pygments_style_default: str | None = pygments_table.get('default')
     pygments_style_dark: str | None = pygments_table.get('dark')
@@ -401,15 +405,23 @@ def _validate_theme_conf(cfg: configparser.RawConfigParser, name: str) -> str:
 
 def _convert_theme_conf(cfg: configparser.RawConfigParser, /) -> _ConfigFile:
     if stylesheet := cfg.get('theme', 'stylesheet', fallback=''):
-        stylesheets: tuple[str, ...] | None = tuple(map(str.strip, stylesheet.split(',')))
+        stylesheets: tuple[str, ...] | None = tuple(
+            map(str.strip, stylesheet.split(','))
+        )
     else:
         stylesheets = None
     if sidebar := cfg.get('theme', 'sidebars', fallback=''):
-        sidebar_templates: tuple[str, ...] | None = tuple(map(str.strip, sidebar.split(',')))
+        sidebar_templates: tuple[str, ...] | None = tuple(
+            map(str.strip, sidebar.split(','))
+        )
     else:
         sidebar_templates = None
-    pygments_style_default: str | None = cfg.get('theme', 'pygments_style', fallback=None)
-    pygments_style_dark: str | None = cfg.get('theme', 'pygments_dark_style', fallback=None)
+    pygments_style_default: str | None = cfg.get(
+        'theme', 'pygments_style', fallback=None
+    )
+    pygments_style_dark: str | None = cfg.get(
+        'theme', 'pygments_dark_style', fallback=None
+    )
     options = dict(cfg.items('options')) if cfg.has_section('options') else {}
     return _ConfigFile(
         stylesheets=stylesheets,