From 95134919673c13112574ac50c1bc96ad1e6f2b33 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Fri, 22 Mar 2024 13:40:05 +0200 Subject: [PATCH 1/8] Exclude bots from generated release notes --- .github/release.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 00000000..9d1e0987 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,5 @@ +changelog: + exclude: + authors: + - dependabot + - pre-commit-ci From fe6a24363611175387dab379b6125d9190ffd7d4 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:43:38 +0200 Subject: [PATCH 2/8] Only show 'Last updated on ...' when last_updated defined --- python_docs_theme/layout.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index d387ef38..a661961a 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -149,7 +149,9 @@

{{ _('Navigation') }}

{% include "footerdonate.html" %}
- {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + {%- if last_updated %} + {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + {%- endif %} {% if theme_issues_url %}{% trans %}Found a bug?{% endtrans %}{% endif %}
From 5c6c0b4856b6c344591c6cb97a004e5db68f0b01 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:51:05 +0200 Subject: [PATCH 3/8] Add newlines to make if blocks clear --- python_docs_theme/layout.html | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index a661961a..9762b06c 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -136,14 +136,24 @@

{{ _('Navigation') }}

{% block footer %}
- © {% if theme_copyright_url or hasdoc('copyright') %}{% endif %}{% trans %}Copyright{% endtrans %}{% if theme_copyright_url or hasdoc('copyright') %}{% endif %} {{ copyright|e }}. + © {% if theme_copyright_url or hasdoc('copyright') %} + + {% endif %} + {% trans %}Copyright{% endtrans %} + {% if theme_copyright_url or hasdoc('copyright') %} + + {% endif %} {{ copyright|e }}.
{% trans %}This page is licensed under the Python Software Foundation License Version 2.{% endtrans %}
{% trans %}Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.{% endtrans %}
- {% if theme_license_url %}{% trans license_file=theme_license_url %}See History and License for more information.{% endtrans %}
{% endif %} - {% if theme_hosted_on %}{% trans hosted_on=theme_hosted_on %}Hosted on {{ hosted_on }}.{% endtrans %}
{% endif %} + {% if theme_license_url %} + {% trans license_file=theme_license_url %}See History and License for more information.{% endtrans %}
+ {% endif %} + {% if theme_hosted_on %} + {% trans hosted_on=theme_hosted_on %}Hosted on {{ hosted_on }}.{% endtrans %}
+ {% endif %}
{% include "footerdonate.html" %} @@ -152,7 +162,9 @@

{{ _('Navigation') }}

{%- if last_updated %} {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} {%- endif %} - {% if theme_issues_url %}{% trans %}Found a bug?{% endtrans %}{% endif %} + {% if theme_issues_url %} + {% trans %}Found a bug?{% endtrans %} + {% endif %}
{% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %} From 7d6728357b1a80b616f65054ad105eb7e2bd9048 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Tue, 26 Mar 2024 15:07:01 +0200 Subject: [PATCH 4/8] Link to kitchen sink demo in README --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 5055bad1..3d78430c 100644 --- a/README.rst +++ b/README.rst @@ -29,3 +29,7 @@ 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/ From 6e87b15170662ecf21ee2955cc916f2c3785489d Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Tue, 26 Mar 2024 15:09:26 +0200 Subject: [PATCH 5/8] Convert README to Markdown --- README.rst => README.md | 17 +++++++---------- pyproject.toml | 2 +- 2 files changed, 8 insertions(+), 11 deletions(-) rename README.rst => README.md (69%) diff --git a/README.rst b/README.md similarity index 69% rename from README.rst rename to README.md index 3d78430c..f77b4910 100644 --- a/README.rst +++ b/README.md @@ -1,5 +1,4 @@ -Python Docs Sphinx Theme -========================= +# Python Docs Sphinx Theme This is the theme for the Python documentation. @@ -10,21 +9,19 @@ 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: diff --git a/pyproject.toml b/pyproject.toml index fc5f5513..c376bbd3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ requires = [ name = "python-docs-theme" version = "2024.3" 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" From 30bd94ff6985256f5bfef03c7f76e1e95cceace6 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Fri, 29 Mar 2024 00:19:50 +0200 Subject: [PATCH 6/8] Add coloured sidebars to versionadded/changed/deprecated --- python_docs_theme/static/pydoctheme.css | 47 ++++++++++++++++++++ python_docs_theme/static/pydoctheme_dark.css | 7 +++ 2 files changed, 54 insertions(+) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 39c4e333..5ca6d3e1 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -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); +} diff --git a/python_docs_theme/static/pydoctheme_dark.css b/python_docs_theme/static/pydoctheme_dark.css index 758d3de6..cae6eae6 100644 --- a/python_docs_theme/static/pydoctheme_dark.css +++ b/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); +} From 059b2c7503ae946e7649d85a9b10c2a42cb21be9 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Tue, 9 Apr 2024 00:54:22 +0300 Subject: [PATCH 7/8] Use system font stack --- python_docs_theme/static/pydoctheme.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 5ca6d3e1..0d7840c0 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/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 { From ab06c27dd08dd3e4206987bf996516eb97bb7245 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Tue, 9 Apr 2024 10:46:27 +0300 Subject: [PATCH 8/8] Prepare 2024.4 release --- CHANGELOG.rst | 10 ++++++++++ pyproject.toml | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 07f7d4c7..6ba1903c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,16 @@ Changelog ========= +`2024.4 `_ +---------------------------------------------------------------------------- + +- Add colour to version change directives (#185) + Contributed by Hugo van Kemenade +- Only show 'Last updated on ...' when ``last_updated`` defined (#183) + Contributed by Hugo van Kemenade +- Use system font stack for all code (#186) + Contributed by Hugo van Kemenade + `2024.3 `_ ---------------------------------------------------------------------------- diff --git a/pyproject.toml b/pyproject.toml index c376bbd3..9e46db68 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ 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.md" license.file = "LICENSE"