python-docs-theme 2024.3__tar.gz → 2024.4__tar.gz

{python_docs_theme-2024.3 → python_docs_theme-2024.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: python-docs-theme
-Version: 2024.3
+Version: 2024.4
 Summary: The Sphinx theme for the CPython docs and related projects
 Author-email: PyPA <distutils-sig@python.org>
 Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
+Description-Content-Type: text/markdown
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Sphinx :: Theme
 Classifier: Intended Audience :: Developers
@@ -25,8 +25,7 @@ Project-URL: Download, https://pypi.org/project/python-docs-theme/
 Project-URL: Homepage, https://github.com/python/python-docs-theme/
 Project-URL: Issue tracker, https://github.com/python/python-docs-theme/issues
 
-Python Docs Sphinx Theme
-=========================
+# Python Docs Sphinx Theme
 
 This is the theme for the Python documentation.
 
@@ -37,23 +36,25 @@ 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).
 
 
-Configuration options
----------------------
+## Configuration options
 
-To use this theme, add the following to ``conf.py``:
+To use this theme, add the following to `conf.py`:
 
-- ``html_theme = 'python_docs_theme'``
+- `html_theme = 'python_docs_theme'`
 
-- ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
+- `html_sidebars`, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
 
-Preview
--------
+## Preview
 
 See a demo of the CPython docs using this theme:
 
 - https://python-docs-theme-previews.readthedocs.io
 
+The kitchen sink is a showcase of every Sphinx feature:
+
+- https://sphinx-themes.org/sample-sites/python-docs-theme/kitchen-sink/
+

python_docs_theme-2024.3/README.rst → python_docs_theme-2024.4/README.md

@@ -1,5 +1,4 @@
-Python Docs Sphinx Theme
-=========================
+# Python Docs Sphinx Theme
 
 This is the theme for the Python documentation.
 
@@ -10,22 +9,24 @@ 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).
 
 
-Configuration options
----------------------
+## Configuration options
 
-To use this theme, add the following to ``conf.py``:
+To use this theme, add the following to `conf.py`:
 
-- ``html_theme = 'python_docs_theme'``
+- `html_theme = 'python_docs_theme'`
 
-- ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
+- `html_sidebars`, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
 
-Preview
--------
+## Preview
 
 See a demo of the CPython docs using this theme:
 
 - https://python-docs-theme-previews.readthedocs.io
+
+The kitchen sink is a showcase of every Sphinx feature:
+
+- https://sphinx-themes.org/sample-sites/python-docs-theme/kitchen-sink/

{python_docs_theme-2024.3 → python_docs_theme-2024.4}/pyproject.toml

@@ -6,9 +6,9 @@ requires = [
 
 [project]
 name = "python-docs-theme"
-version = "2024.3"
+version = "2024.4"
 description = "The Sphinx theme for the CPython docs and related projects"
-readme = "README.rst"
+readme = "README.md"
 license.file = "LICENSE"
 authors = [{name = "PyPA", email = "distutils-sig@python.org"}]
 requires-python = ">=3.8"

{python_docs_theme-2024.3 → python_docs_theme-2024.4}/python_docs_theme/layout.html

@@ -136,21 +136,35 @@
 
 {% block footer %}
     <div class="footer">
-    &copy; {% if theme_copyright_url or hasdoc('copyright') %}<a href="{% if theme_copyright_url %}{{ theme_copyright_url }}{% else %}{{ pathto('copyright') }}{% endif %}">{% endif %}{% trans %}Copyright{% endtrans %}{% if theme_copyright_url or hasdoc('copyright') %}</a>{% endif %} {{ copyright|e }}.
+    &copy; {% if theme_copyright_url or hasdoc('copyright') %}
+      <a href="{% if theme_copyright_url %}{{ theme_copyright_url }}{% else %}{{ pathto('copyright') }}{% endif %}">
+    {% endif %}
+    {% trans %}Copyright{% endtrans %}
+    {% if theme_copyright_url or hasdoc('copyright') %}
+      </a>
+    {% endif %} {{ copyright|e }}.
     <br />
     {% trans %}This page is licensed under the Python Software Foundation License Version 2.{% endtrans %}
     <br />
     {% 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 %}
+    {% 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" %}
     <br />
 
-    {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
-    {% if theme_issues_url %}{% trans %}<a href="{{ theme_issues_url }}">Found a bug</a>?{% endtrans %}{% endif %}
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+    {%- endif %}
+    {% if theme_issues_url %}
+      {% trans %}<a href="{{ theme_issues_url }}">Found a bug</a>?{% endtrans %}
+    {% endif %}
     <br />
 
     {% trans sphinx_version=sphinx_version|e %}Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}

{python_docs_theme-2024.3 → python_docs_theme-2024.4}/python_docs_theme/static/pydoctheme.css

@@ -333,7 +333,7 @@ div.footer a:hover {
 
 dl > dt span ~ em,
 .sig {
-    font-family: ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", Menlo, Monaco, Consolas, monospace;
+    font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace;
 }
 
 .toctree-wrapper ul {
@@ -622,3 +622,50 @@ div.genindex-jumpbox a {
         margin-top: -2em;
     }
 }
+
+/* Version change directives */
+:root {
+    --versionadded: rgb(41 100 51);
+    --versionchanged: rgb(133 72 38);
+    --deprecated: rgb(159 49 51);
+
+    --versionadded-border: rgb(79 196 100);
+    --versionchanged-border: rgb(244, 227, 76);
+    --deprecated-border: rgb(244, 76, 78);
+}
+
+div.versionadded,
+div.versionchanged,
+div.deprecated,
+div.deprecated-removed {
+    border-left: 3px solid;
+    padding: 0 1rem;
+}
+
+div.versionadded {
+    border-left-color: var(--versionadded-border);
+}
+
+div.versionchanged {
+    border-left-color: var(--versionchanged-border);
+}
+
+div.deprecated,
+div.deprecated-removed,
+div.versionremoved {
+    border-left-color: var(--deprecated-border);
+}
+
+div.versionadded .versionmodified {
+    color: var(--versionadded);
+}
+
+div.versionchanged .versionmodified {
+    color: var(--versionchanged);
+}
+
+div.deprecated .versionmodified,
+div.deprecated-removed .versionmodified,
+div.versionremoved .versionmodified {
+    color: var(--deprecated);
+}

{python_docs_theme-2024.3 → python_docs_theme-2024.4}/python_docs_theme/static/pydoctheme_dark.css

@@ -140,3 +140,10 @@ img.invert-in-dark-mode {
 .sig.cpp .k, .sig.cpp .kt {
     color: #5283ff;
 }
+
+/* Version change directives */
+:root {
+    --versionadded: rgb(79 196 100);
+    --versionchanged: rgb(244, 227, 76);
+    --deprecated: rgb(244, 76, 78);
+}