python-docs-theme 2023.9__tar.gz → 2024.2__tar.gz

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-docs-theme
-Version: 2023.9
+Version: 2024.2
 Summary: The Sphinx theme for the CPython docs and related projects
 Author-email: PyPA <distutils-sig@python.org>
 Requires-Python: >=3.8
@@ -10,16 +10,16 @@ Classifier: Framework :: Sphinx :: Theme
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Python Software Foundation License
 Classifier: Operating System :: OS Independent
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Documentation
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
 Project-URL: Code, https://github.com/python/python-docs-theme
 Project-URL: Download, https://pypi.org/project/python-docs-theme/
 Project-URL: Homepage, https://github.com/python/python-docs-theme/
@@ -37,7 +37,7 @@ projects if you so choose, but please keep in mind that in doing so you're also
 choosing to accept some of the responsibility for maintaining that collective
 trust.
 
-To use the theme, install it into your docs build environment via ``pip`` 
+To use the theme, install it into your docs build environment via ``pip``
 (preferably in a virtual environment).
 
 
@@ -48,5 +48,12 @@ To use this theme, add the following to ``conf.py``:
 
 - ``html_theme = 'python_docs_theme'``
 
-- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
+- ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
+
+Preview
+-------
+
+See a demo of the CPython docs using this theme:
+
+- https://python-docs-theme-previews.readthedocs.io
 

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/README.rst

@@ -10,7 +10,7 @@ projects if you so choose, but please keep in mind that in doing so you're also
 choosing to accept some of the responsibility for maintaining that collective
 trust.
 
-To use the theme, install it into your docs build environment via ``pip`` 
+To use the theme, install it into your docs build environment via ``pip``
 (preferably in a virtual environment).
 
 
@@ -21,4 +21,11 @@ To use this theme, add the following to ``conf.py``:
 
 - ``html_theme = 'python_docs_theme'``
 
-- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
+- ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
+
+Preview
+-------
+
+See a demo of the CPython docs using this theme:
+
+- https://python-docs-theme-previews.readthedocs.io

python_docs_theme-2024.2/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+build-backend = "flit_core.buildapi"
+requires = [
+  "flit_core>=3.7",
+]
+
+[project]
+name = "python-docs-theme"
+version = "2024.2"
+description = "The Sphinx theme for the CPython docs and related projects"
+readme = "README.rst"
+license.file = "LICENSE"
+authors = [{name = "PyPA", email = "distutils-sig@python.org"}]
+requires-python = ">=3.8"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Framework :: Sphinx :: Theme",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Python Software Foundation License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Documentation",
+  "Topic :: Software Development :: Documentation",
+]
+urls.Code = "https://github.com/python/python-docs-theme"
+urls.Download = "https://pypi.org/project/python-docs-theme/"
+urls.Homepage = "https://github.com/python/python-docs-theme/"
+urls."Issue tracker" = "https://github.com/python/python-docs-theme/issues"
+[project.entry-points."sphinx.html_themes"]
+python_docs_theme = 'python_docs_theme'
+
+[tool.flit.module]
+name = "python_docs_theme"
+
+[tool.flit.sdist]
+include = [
+    "python_docs_theme/",
+]

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/python_docs_theme/__init__.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
 import hashlib
 import os
 from functools import lru_cache
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any
 
 import sphinx.application
 from sphinx.builders.html import StandaloneHTMLBuilder
@@ -19,7 +21,7 @@ def _asset_hash(path: str) -> str:
     return f"{path}?digest={digest}"
 
 
-def _add_asset_hashes(static: List[str], add_digest_to: List[str]) -> None:
+def _add_asset_hashes(static: list[str], add_digest_to: list[str]) -> None:
     for asset in add_digest_to:
         index = static.index(asset)
         static[index].filename = _asset_hash(asset)  # type: ignore
@@ -29,7 +31,7 @@ def _html_page_context(
     app: sphinx.application.Sphinx,
     pagename: str,
     templatename: str,
-    context: Dict[str, Any],
+    context: dict[str, Any],
     doctree: Any,
 ) -> None:
     if app.config.html_theme != "python_docs_theme":

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/python_docs_theme/layout.html

@@ -14,7 +14,7 @@
           </li>
           {%- endfor %}
           {%- block rootrellink %}
-          <li><img src="{{ pathto('_static/py.svg', 1) }}" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
+          <li><img src="{{ pathto('_static/' ~ theme_root_icon, 1) }}" alt="{{ theme_root_icon_alt_text }}" style="vertical-align: middle; margin-top: -1px"/></li>
           <li><a href="{{theme_root_url}}">{{theme_root_name}}</a>{{ reldelim1 }}</li>
           <li class="switchers">
             <div class="language_switcher_placeholder"></div>
@@ -71,7 +71,7 @@
 
 {%- block extrahead -%}
     <link rel="stylesheet" href="{{ pathto('_static/pydoctheme_dark.css', 1) }}" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
-    <link rel="shortcut icon" type="image/png" href="{{ pathto('_static/' + theme_root_icon, 1) }}" />
+    <link rel="shortcut icon" type="image/png" href="{{ pathto('_static/' ~ theme_root_icon, 1) }}" />
     {%- if builder != "htmlhelp" %}
         {%- if not embedded %}
             <script type="text/javascript" src="{{ pathto('_static/copybutton.js', 1) }}"></script>
@@ -100,7 +100,7 @@
         </label>
         <span class="nav-items-wrapper">
             <a href="{{ theme_root_url }}" class="nav-logo">
-                <img src="{{ pathto('_static/py.svg', 1) }}" alt="Logo"/>
+                <img src="{{ pathto('_static/' ~ theme_root_icon, 1) }}" alt="{{ theme_root_icon_alt_text }}"/>
             </a>
             <span class="version_switcher_placeholder"></span>
             {%- if pagename != "search" and builder != "singlehtml" %}
@@ -121,7 +121,7 @@
             {%- if logo %}
             <p class="logo">
                 <a href="{{ pathto('index') }}">
-                <img class="logo" src="{{ pathto('_static/' + logo, 1)|e }}" alt="Logo"/>
+                <img class="logo" src="{{ pathto('_static/' ~ logo, 1)|e }}" alt="Logo"/>
                 </a>
             </p>
             {%- endif %}
@@ -143,6 +143,7 @@
     {% trans %}Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.{% endtrans %}
     <br />
     {% if theme_license_url %}{% trans license_file=theme_license_url %}See <a href="{{ license_file }}">History and License</a> for more information.{% endtrans %}<br />{% endif %}
+    {% if theme_hosted_on %}{% trans hosted_on=theme_hosted_on %}Hosted on {{ hosted_on }}.{% endtrans %}<br />{% endif %}
     <br />
 
     {% include "footerdonate.html" %}

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/python_docs_theme/static/menu.js

@@ -54,4 +54,4 @@ document.addEventListener("DOMContentLoaded", function () {
             closeMenu()
         }
     })
-})
+})

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/python_docs_theme/static/pydoctheme.css

@@ -29,6 +29,42 @@ pre {
     color: inherit;
 }
 
+/* Add underlines to links */
+a[href] {
+    text-decoration: underline 1px;
+}
+
+/* Increase the underline offset for code to avoid obscuring underscores */
+a[href]:has(> code) {
+    text-underline-offset: 0.25em;
+}
+
+/* No underline for navigation */
+a.headerlink,
+div.genindex-jumpbox a,
+div.modindex-jumpbox a,
+div#search-results a,
+div.sphinxsidebar a,
+div.toctree-wrapper a,
+div[role=navigation] a,
+table.contentstable a,
+table.indextable a {
+    text-decoration: none;
+}
+
+/* Except when hovered */
+div.genindex-jumpbox a:hover,
+div.modindex-jumpbox a:hover,
+div#search-results a:hover,
+div.sphinxsidebar a:hover,
+div.toctree-wrapper a:hover,
+div[role=navigation] a:hover,
+table.contentstable a:hover,
+table.indextable a:hover {
+    text-decoration: underline;
+    text-underline-offset: auto;
+}
+
 body {
     margin-left: 1em;
     margin-right: 1em;
@@ -177,7 +213,7 @@ div.body {
 
 div.body p, div.body dd, div.body li, div.body blockquote {
     text-align: left;
-    line-height: 1.4;
+    line-height: 1.6;
 }
 div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6 {
     margin: 0;
@@ -279,6 +315,10 @@ div.footer {
     margin-right: 10px;
 }
 
+div.footer a {
+    text-underline-offset: auto;
+}
+
 div.footer a:hover {
     color: #0095c4;
 }

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/python_docs_theme/static/pydoctheme_dark.css

@@ -60,6 +60,10 @@ span.highlighted {
     background-color: #616161;
 }
 
+.footnote:target {
+    background-color: #2c3e50;
+}
+
 /* Below for most things in text */
 
 dl.field-list > dt {

{python_docs_theme-2023.9 → python_docs_theme-2024.2}/python_docs_theme/theme.conf

@@ -26,10 +26,12 @@ headlinkcolor = #aaaaaa
 codebgcolor = #eeffcc
 codetextcolor = #333333
 
+hosted_on =
 issues_url =
 license_url =
 root_name = Python
 root_url = https://www.python.org/
 root_icon = py.svg
+root_icon_alt_text = Python logo
 root_include_title = True
 copyright_url =

python_docs_theme-2023.9/pyproject.toml

@@ -1,50 +0,0 @@
-[build-system]
-requires = ["flit_core>=3.7"]
-build-backend = "flit_core.buildapi"
-
-# project metadata
-[project]
-name = "python-docs-theme"
-version = "2023.9"
-description = "The Sphinx theme for the CPython docs and related projects"
-readme = "README.rst"
-urls.Code = "https://github.com/python/python-docs-theme"
-urls.Download = "https://pypi.org/project/python-docs-theme/"
-urls.Homepage = "https://github.com/python/python-docs-theme/"
-urls."Issue tracker" = "https://github.com/python/python-docs-theme/issues"
-license.file = "LICENSE"
-requires-python = ">=3.8"
-
-# Classifiers list: https://pypi.org/classifiers/
-classifiers = [
-    "Development Status :: 5 - Production/Stable",
-    "Framework :: Sphinx :: Theme",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: Python Software Foundation License",
-    "Operating System :: OS Independent",
-    "Topic :: Documentation",
-    "Topic :: Software Development :: Documentation",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-]
-
-[[project.authors]]
-name = "PyPA"
-email = "distutils-sig@python.org"
-
-[project.entry-points."sphinx.html_themes"]
-python_docs_theme = 'python_docs_theme'
-
-[tool.flit.module]
-name = "python_docs_theme"
-
-[tool.flit.sdist]
-include = [
-    "python_docs_theme/",
-]