From ae83e69a9ce370c9f7f4c27bd37ad5e6536fea76 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 2 Nov 2025 07:09:51 +0800 Subject: [PATCH 1/8] Bump the actions group with 2 updates (#278) Bumps the actions group with 2 updates: [actions/download-artifact](https://github.com/actions/download-artifact) and [actions/upload-artifact](https://github.com/actions/upload-artifact). Updates `actions/download-artifact` from 5 to 6 - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](https://github.com/actions/download-artifact/compare/v5...v6) Updates `actions/upload-artifact` from 4 to 5 - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/download-artifact dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major dependency-group: actions - dependency-name: actions/upload-artifact dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major dependency-group: actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/pypi-package.yml | 2 +- .github/workflows/tests.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pypi-package.yml b/.github/workflows/pypi-package.yml index d3a55a2..ed0ec1d 100644 --- a/.github/workflows/pypi-package.yml +++ b/.github/workflows/pypi-package.yml @@ -48,7 +48,7 @@ jobs: steps: - name: Download packages built by build-and-inspect-python-package - uses: actions/download-artifact@v5 + uses: actions/download-artifact@v6 with: name: Packages path: dist diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 2b6570a..a970872 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -45,7 +45,7 @@ jobs: run: | cat ./logs/docsbuild.log - name: Upload - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: doc-html-${{ matrix.branch }} path: www/ From 4e36f99d6ecc10ea7867959d3f25761a798d7afa Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Fri, 28 Nov 2025 12:38:09 +0200 Subject: [PATCH 2/8] Add support for Python 3.15 (#282) --- .github/workflows/tests.yml | 13 ++++++++----- pyproject.toml | 3 ++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index a970872..1cc1836 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -12,12 +12,15 @@ jobs: strategy: fail-fast: false matrix: - branch: ["3.14", "3.13", "3.12"] + python-version: ["3.15", "3.14", "3.13", "3.12"] + include: + - python-version: "3.15" + branch: "main" steps: - uses: actions/checkout@v5 - uses: actions/setup-python@v6 with: - python-version: ${{ matrix.branch }} + python-version: ${{ matrix.python-version }} allow-prereleases: true cache: pip - name: Clone docsbuild scripts @@ -38,8 +41,8 @@ jobs: --skip-cache-invalidation --theme "$(pwd)" --languages en - --branches ${{ matrix.branch }} - ${{ matrix.branch == '3.14' && '--select-output no-html' || '' }} + --branches ${{ matrix.branch || matrix.python-version }} + ${{ matrix.branch == 'main' && '--select-output no-html' || '' }} - name: Show logs if: failure() run: | @@ -47,7 +50,7 @@ jobs: - name: Upload uses: actions/upload-artifact@v5 with: - name: doc-html-${{ matrix.branch }} + name: doc-html-${{ matrix.python-version }} path: www/ translations: diff --git a/pyproject.toml b/pyproject.toml index e054d1a..b8598f5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,6 +22,7 @@ classifiers = [ "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14", + "Programming Language :: Python :: 3.15", "Topic :: Documentation", "Topic :: Software Development :: Documentation", ] @@ -70,4 +71,4 @@ lint.ignore = [ lint.isort.required-imports = [ "from __future__ import annotations" ] [tool.pyproject-fmt] -max_supported_python = "3.14" +max_supported_python = "3.15" From 498d07fed243b9821bf43308d18c4aa0ebeebfff Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 10:53:23 +0800 Subject: [PATCH 3/8] Bump actions/checkout from 5 to 6 in the actions group (#284) Bumps the actions group with 1 update: [actions/checkout](https://github.com/actions/checkout). Updates `actions/checkout` from 5 to 6 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v5...v6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major dependency-group: actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/lint.yml | 2 +- .github/workflows/pypi-package.yml | 2 +- .github/workflows/tests.yml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 088871c..cefaff1 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-python@v6 with: python-version: "3.x" diff --git a/.github/workflows/pypi-package.yml b/.github/workflows/pypi-package.yml index ed0ec1d..3c6652b 100644 --- a/.github/workflows/pypi-package.yml +++ b/.github/workflows/pypi-package.yml @@ -21,7 +21,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-python@v6 - name: Compile translations diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 1cc1836..a0ce5d2 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -17,7 +17,7 @@ jobs: - python-version: "3.15" branch: "main" steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} @@ -62,7 +62,7 @@ jobs: # Test minimum supported and latest stable from 3.x series python-version: ["3.12", "3"] steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} From c6ef663286ddc3bc61d6d1054e9e39d62d44f155 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Mon, 8 Dec 2025 19:30:59 +0200 Subject: [PATCH 4/8] Convert CHANGELOG and CONTRIBUTING from .rst to .md (#277) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> --- CHANGELOG.rst => CHANGELOG.md | 112 +++++++++++++--------------------- CONTRIBUTING.md | 26 ++++++++ CONTRIBUTING.rst | 28 --------- 3 files changed, 67 insertions(+), 99 deletions(-) rename CHANGELOG.rst => CHANGELOG.md (58%) create mode 100644 CONTRIBUTING.md delete mode 100644 CONTRIBUTING.rst diff --git a/CHANGELOG.rst b/CHANGELOG.md similarity index 58% rename from CHANGELOG.rst rename to CHANGELOG.md index 9ce048d..3221e1b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.md @@ -1,50 +1,42 @@ -Changelog -========= +# Changelog -`2025.10 `_ -------------------------------------------------------------------------------- +## [2025.10](https://github.com/python/python-docs-theme/releases/tag/2025.10) * Add Romanian translation by @octaG-M in https://github.com/python/python-docs-theme/pull/272 * Add Arabic and Russian translations by @StanFromIreland in https://github.com/python/python-docs-theme/pull/274 * Add French translation by @JulienPalard in https://github.com/python/python-docs-theme/pull/275 -* Update authors in ``pyproject.toml`` by @StanFromIreland in https://github.com/python/python-docs-theme/pull/271 +* Update authors in `pyproject.toml` by @StanFromIreland in https://github.com/python/python-docs-theme/pull/271 * Add link to devguide in README by @StanFromIreland in https://github.com/python/python-docs-theme/pull/266 -`2025.9.2 `_ -------------------------------------------------------------------------------- +## [2025.9.2](https://github.com/python/python-docs-theme/releases/tag/2025.9.2) * Add Korean and Indonesian translations from Transifex in https://github.com/python/python-docs-theme/pull/264 * Add German translation by @cmaureir in https://github.com/python/python-docs-theme/pull/262 * Fix compilation of translations and loading of translations on pages with html source in https://github.com/python/python-docs-theme/pull/263 * Fix search button cutting off long translations in https://github.com/python/python-docs-theme/pull/268 -* Fix ``Copy`` button copying line numbers by @StanFromIreland in https://github.com/python/python-docs-theme/pull/270 +* Fix `Copy` button copying line numbers by @StanFromIreland in https://github.com/python/python-docs-theme/pull/270 -`2025.9.1 `_ -------------------------------------------------------------------------------- +## [2025.9.1](https://github.com/python/python-docs-theme/releases/tag/2025.9.1) * Add Japanese, Turkish and Spanish translations from Transifex in https://github.com/python/python-docs-theme/pull/259 -`2025.9 `_ ---------------------------------------------------------------------------- +## [2025.9](https://github.com/python/python-docs-theme/releases/tag/2025.9) * Enable theme translation and add Polish by @StanFromIreland in https://github.com/python/python-docs-theme/pull/246 * Add Greek translation by @lysnikolaou and @skpanagiotis in https://github.com/python/python-docs-theme/pull/256 and https://github.com/python/python-docs-theme/pull/257 * Add Swedish translation by @yeager in https://github.com/python/python-docs-theme/pull/250 -* Add Brazilian Portuguese, Simplified Chinese and Traditional Chinese translations from `Transifex `_ in https://github.com/python/python-docs-theme/pull/253 +* Add Brazilian Portuguese, Simplified Chinese and Traditional Chinese translations from [Transifex](https://explore.transifex.com/python-doc/python-docs-theme/) in https://github.com/python/python-docs-theme/pull/253 -`2025.5 `_ ---------------------------------------------------------------------------- +## [2025.5](https://github.com/python/python-docs-theme/releases/tag/2025.5) * Make the copy button only appear when hovered over or clicked on by @kevteg in https://github.com/python/python-docs-theme/pull/243 -`2025.4.1 `_ -------------------------------------------------------------------------------- +## [2025.4.1](https://github.com/python/python-docs-theme/releases/tag/2025.4.1) * Fix copy button with multiple tracebacks by @tomasr8 in https://github.com/python/python-docs-theme/pull/240 -`2025.4 `_ ---------------------------------------------------------------------------- +## [2025.4](https://github.com/python/python-docs-theme/releases/tag/2025.4) * Require Sphinx 7.3 by @AA-Turner in https://github.com/python/python-docs-theme/pull/221 * Add support for Python 3.14 by @hugovk https://github.com/python/python-docs-theme/pull/236 @@ -55,8 +47,7 @@ Changelog * Remove self-closing tags by @hugovk in https://github.com/python/python-docs-theme/pull/226 * Replace deprecated classifier with licence expression (PEP 639) by @hugovk in https://github.com/python/python-docs-theme/pull/237 -`2025.2 `_ ---------------------------------------------------------------------------- +## [2025.2](https://github.com/python/python-docs-theme/releases/tag/2025.2) - Note minimum requirements for Sphinx (#216) Contributed by Adam Turner @@ -64,17 +55,15 @@ Changelog Contributed by Tomas Roun - Make sidebar width more flexible (#218) Contributed by Tomas Roun -- Set ``__version__`` in the runtime package (#222) +- Set `__version__` in the runtime package (#222) Contributed by Adam Turner -`2024.12 `_ ------------------------------------------------------------------------------ +## [2024.12](https://github.com/python/python-docs-theme/releases/tag/2024.12) - Hide header and search bar when printing (#204) Contributed by Hugo van Kemenade -`2024.10 `_ ------------------------------------------------------------------------------ +## [2024.10](https://github.com/python/python-docs-theme/releases/tag/2024.10) - Add support for Python 3.13 (#196) Contributed by Hugo van Kemenade @@ -85,60 +74,53 @@ Changelog - Generate digital attestations for PyPI (PEP 740) (#198) Contributed by Hugo van Kemenade -`2024.6 `_ ---------------------------------------------------------------------------- +## [2024.6](https://github.com/python/python-docs-theme/releases/tag/2024.6) - Add backgrounds and borders to admonitions (#190) Contributed by Hugo van Kemenade - Use different colour for 'Return value: Borrowed reference' (#188) Contributed by Hugo van Kemenade -`2024.4 `_ ---------------------------------------------------------------------------- +## [2024.4](https://github.com/python/python-docs-theme/releases/tag/2024.4) - Add colour to version change directives (#185) Contributed by Hugo van Kemenade -- Only show 'Last updated on ...' when ``last_updated`` defined (#183) +- 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 `_ ---------------------------------------------------------------------------- +## [2024.3](https://github.com/python/python-docs-theme/releases/tag/2024.3) - Modernise font: use system font stack to improve text readability and webpage performance (#174) Contributed by Hugo van Kemenade - Remove incorrect CSS property (#178) Contributed by Kerim Kabirov -`2024.2 `_ ---------------------------------------------------------------------------- +## [2024.2](https://github.com/python/python-docs-theme/releases/tag/2024.2) - Do not underline navigation links (#169) Contributed by Hugo van Kemenade - Only apply underline offset to code formatting for underline visibility (#171) Contributed by Hugo van Kemenade -`2024.1 `_ ---------------------------------------------------------------------------- +## [2024.1](https://github.com/python/python-docs-theme/releases/tag/2024.1) - Underline links for readability and a11y (#160, #166) Contributed by Hugo van Kemenade -- Add ``hosted_on`` variable for a link in the footer (#165) +- Add `hosted_on` variable for a link in the footer (#165) Contributed by Hugo van Kemenade -- Consistently reference ``theme_root_icon`` (#163) +- Consistently reference `theme_root_icon` (#163) Contributed by Marko Budiselic - Dark mode: fix contrast of footer highlight (#162) Contributed by Hugo van Kemenade -`2023.9 `_ ---------------------------------------------------------------------------- +## [2023.9](https://github.com/python/python-docs-theme/releases/tag/2023.9) - Focus search box when pressing slash (#153) Contributed by Hugo van Kemenade -`2023.8 `_ ---------------------------------------------------------------------------- +## [2023.8](https://github.com/python/python-docs-theme/releases/tag/2023.8) - Add Python 3.12 and 3.13 classifiers (#147) Contributed by Hugo van Kemenade @@ -147,14 +129,13 @@ Changelog - Restore the menu on mobile devices (inadvertently broken in 2023.7) (#146) Contributed by Hugo van Kemenade -`2023.7 `_ ---------------------------------------------------------------------------- +## [2023.7](https://github.com/python/python-docs-theme/releases/tag/2023.7) - Fix compatibility with Sphinx 7.1 (#137) Contributed by Pradyun Gedam - Enable the slash keypress to focus the search field (#141) Contributed by Mike Fiedler -- Sphinx 6.2 fix: add ``nav.contents`` where ``div.topic`` is used (#138) +- Sphinx 6.2 fix: add `nav.contents` where `div.topic` is used (#138) Contributed by Hugo van Kemenade - Dark mode: fix contrast for C++ specific styling (#133) Contributed by Hugo van Kemenade @@ -163,29 +144,26 @@ Changelog - Test with Python 3.12 (#140) Contributed by Hugo van Kemenade -`2023.5 `_ ---------------------------------------------------------------------------- +## [2023.5](https://github.com/python/python-docs-theme/releases/tag/2023.5) - Add a dark theme. (#44) Contributed by Nils K - Fix: Remove searchbox id from form. (fixes #117) Contributed by Nils K -- Update ``python-docs-theme`` to work with Sphinx 5 & 6. (#99 & #127) +- Update `python-docs-theme` to work with Sphinx 5 & 6. (#99 & #127) Contributed by Adam Turner -- Override font for ``.sig`` for consistency with other code blocks. (#121) +- Override font for `.sig` for consistency with other code blocks. (#121) Contributed by Chris Warrick - Dark mode: add class to invert image brightness. (#128) Contributed by Hugo van Kemenade -`2023.3.1 `_ -------------------------------------------------------------------------------- +## [2023.3.1](https://github.com/python/python-docs-theme/releases/tag/2023.3.1) - Skip cache-busting for old Sphinx #113 -`2023.3 `_ ---------------------------------------------------------------------------- +## [2023.3](https://github.com/python/python-docs-theme/releases/tag/2023.3) - Fix problem with monospace rendering in Vivaldi #104 - Fix mobile nav obstructing content #96 @@ -193,30 +171,26 @@ Changelog - Append a hash ?digest to CSS files for cache-busting #108 -`2022.1 `_ ----------------------------------------------------------------------------- +## [2022.1](https://github.com/python/python-docs-theme/releases/tag/2022.1) - Add a configuration for license URL. (#90) - Exclude the floating navbar from CHM help. (#84) - Make sidebar scrollable and sticky (on modern browsers) (#91) -`2021.11.1 `_ ----------------------------------------------------------------------------------- +## [2021.11.1](https://github.com/python/python-docs-theme/releases/tag/2021.11.1) - Fix monospace again, on buggy Google Chrome (#87) Contributed by Tushar Sadhwani -`2021.11 `_ ------------------------------------------------------------------------------- +## [2021.11](https://github.com/python/python-docs-theme/releases/tag/2021.11) - Fix monospace on buggy Google Chrome (#85) Contributed by Tushar Sadhwani -`2021.8 `_ ------------------------------------------------------------------------------ +## [2021.8](https://github.com/python/python-docs-theme/releases/tag/2021.8) - Add the copyright_url variable in the theme (#67) Contributed by jablonskidev @@ -228,8 +202,7 @@ Changelog Contributed by Olga Bulat -`2021.5 `_ ------------------------------------------------------------------------------ +## [2021.5](https://github.com/python/python-docs-theme/releases/tag/2021.5) - Make the theme responsive (#46) Contributed by Olga Bulat. @@ -243,8 +216,7 @@ Changelog Contributed by Julien Palard. -`2020.12 `_ ------------------------------------------------------------------------------- +## [2020.12](https://github.com/python/python-docs-theme/releases/tag/v2020.12) - Updated the readme, to remind user to install the package in a virtual environment. (#41) Contributed by Mariatta. @@ -261,12 +233,10 @@ Changelog - Fixed code bgcolor and codetextcolor for Sphinx 3.1.0+ (#57) Contributed by Zhiming Wang. -2018.7 ------- -Corresponds to `44a8f30 `_ +## 2018.7 +Corresponds to [44a8f30](https://github.com/python/python-docs-theme/commit/44a8f306db9ec86d277a8a687538d5d51e415130) -`2018.2 `_ ---------------------------------------------------------------------------- +## [2018.2](https://github.com/python/python-docs-theme/releases/tag/2018.2) Initial release. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f26b902 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# How to release + +- Update `CHANGELOG.md` +- Bump version (YYYY.MM) in `python_docs_theme/__init__.py` +- Commit +- Push to check tests pass on + [GitHub Actions](https://github.com/python/python-docs-theme/actions) +- Go to https://github.com/python/python-docs-theme/releases +- Click "Draft a new release" +- Click "Choose a tag" +- Type the next YYYY.MM version (no leading zero) and + select "**Create new tag: YYYY.MM** on publish" +- Leave the "Release title" blank (it will be autofilled) +- Click "Generate release notes" and amend as required +- Click "Publish release" +- Check the tagged [GitHub Actions build](https://github.com/python/python-docs-theme/actions/workflows/pypi-package.yml) + has deployed to [PyPI](https://pypi.org/project/python-docs-theme/#history) + +# Makefile usage + +This project includes a simple Makefile for syncing changes to the theme with +the main CPython repository. Run `make help` for details on available rules. + +There is one configurable variable, `CPYTHON_PATH`, which should be the path +to the CPython repository on your machine. By default, it points to +`../cpython`. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index c85b77c..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,28 +0,0 @@ -How to release --------------- - -- Update ``CHANGELOG.rst`` -- Bump version (YYYY.MM) in ``python_docs_theme/__init__.py`` -- Commit -- Push to check tests pass on - `GitHub Actions `__ -- Go to https://github.com/python/python-docs-theme/releases -- Click "Draft a new release" -- Click "Choose a tag" -- Type the next YYYY.MM version (no leading zero) and - select "**Create new tag: YYYY.MM** on publish" -- Leave the "Release title" blank (it will be autofilled) -- Click "Generate release notes" and amend as required -- Click "Publish release" -- Check the tagged `GitHub Actions build `__ - has deployed to `PyPI `__ - -Makefile usage --------------- - -This project includes a simple Makefile for syncing changes to the theme with -the main CPython repository. Run ``make help`` for details on available rules. - -There is one configurable variable, ``CPYTHON_PATH``, which should be the path -to the CPython repository on your machine. By default, it points to -``../cpython``. From 35db2d5db7d349d9249d9c8eb0f7655a8fdda3d8 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Mon, 8 Dec 2025 19:39:28 +0200 Subject: [PATCH 5/8] Add zizmor to CI and fix findings (#283) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- .github/dependabot.yml | 2 ++ .github/workflows/lint.yml | 8 +++++--- .github/workflows/pypi-package.yml | 7 +++---- .github/workflows/tests.yml | 6 ++++++ .github/zizmor.yml | 10 ++++++++++ .pre-commit-config.yaml | 5 +++++ 6 files changed, 31 insertions(+), 7 deletions(-) create mode 100644 .github/zizmor.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 8452ef0..5621e4b 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -10,3 +10,5 @@ updates: actions: patterns: - "*" + cooldown: + default-days: 7 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index cefaff1..3a2f852 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -2,11 +2,11 @@ name: Lint on: [push, pull_request, workflow_dispatch] +permissions: {} + env: FORCE_COLOR: 1 - -permissions: - contents: read + RUFF_OUTPUT_FORMAT: github jobs: lint: @@ -14,6 +14,8 @@ jobs: steps: - uses: actions/checkout@v6 + with: + persist-credentials: false - uses: actions/setup-python@v6 with: python-version: "3.x" diff --git a/.github/workflows/pypi-package.yml b/.github/workflows/pypi-package.yml index 3c6652b..885c30b 100644 --- a/.github/workflows/pypi-package.yml +++ b/.github/workflows/pypi-package.yml @@ -8,8 +8,7 @@ on: - published workflow_dispatch: -permissions: - contents: read +permissions: {} env: FORCE_COLOR: 1 @@ -22,6 +21,8 @@ jobs: steps: - uses: actions/checkout@v6 + with: + persist-credentials: false - uses: actions/setup-python@v6 - name: Compile translations @@ -55,5 +56,3 @@ jobs: - name: Upload package to PyPI uses: pypa/gh-action-pypi-publish@release/v1 - with: - attestations: true diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index a0ce5d2..7b9875e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -2,6 +2,8 @@ name: Tests on: [push, pull_request, workflow_dispatch] +permissions: {} + env: FORCE_COLOR: 1 @@ -18,6 +20,8 @@ jobs: branch: "main" steps: - uses: actions/checkout@v6 + with: + persist-credentials: false - uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} @@ -63,6 +67,8 @@ jobs: python-version: ["3.12", "3"] steps: - uses: actions/checkout@v6 + with: + persist-credentials: false - uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} diff --git a/.github/zizmor.yml b/.github/zizmor.yml new file mode 100644 index 0000000..9b42b47 --- /dev/null +++ b/.github/zizmor.yml @@ -0,0 +1,10 @@ +# Configuration for the zizmor static analysis tool, run via pre-commit in CI +# https://woodruffw.github.io/zizmor/configuration/ +rules: + dangerous-triggers: + ignore: + - documentation-links.yml + unpinned-uses: + config: + policies: + "*": ref-pin diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9a7e83b..af1d14d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -32,6 +32,11 @@ repos: hooks: - id: actionlint + - repo: https://github.com/woodruffw/zizmor-pre-commit + rev: v1.17.0 + hooks: + - id: zizmor + - repo: https://github.com/tox-dev/pyproject-fmt rev: v2.5.0 hooks: From bf2c2d72a40a725cc61e26468014527b7e899d6b Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 10 Dec 2025 17:13:14 +0200 Subject: [PATCH 6/8] Add green, red and yellow side borders for code examples (#285) --- python_docs_theme/static/pydoctheme.css | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index d7b729f..ec2d285 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -235,6 +235,18 @@ div.body pre { border: 1px solid #ac9; } +div.body { + .good pre { + border-left: 3px solid var(--good-border); + } + .bad pre { + border-left: 3px solid var(--bad-border); + } + .maybe pre { + border-left: 3px solid var(--middle-border); + } +} + /* Admonitions */ :root { --admonition-background: #eee; From d0b901d0e8e24fd91ebde32d36a7366fbd234e6a Mon Sep 17 00:00:00 2001 From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Date: Wed, 10 Dec 2025 15:17:12 +0000 Subject: [PATCH 7/8] Add Portuguese translation --- .../pt/LC_MESSAGES/python-docs-theme.po | 129 ++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 python_docs_theme/locale/pt/LC_MESSAGES/python-docs-theme.po diff --git a/python_docs_theme/locale/pt/LC_MESSAGES/python-docs-theme.po b/python_docs_theme/locale/pt/LC_MESSAGES/python-docs-theme.po new file mode 100644 index 0000000..27eeba6 --- /dev/null +++ b/python_docs_theme/locale/pt/LC_MESSAGES/python-docs-theme.po @@ -0,0 +1,129 @@ +# Translations template for python-docs-theme. +# Copyright (C) 2025 Python Software Foundation +# This file is distributed under the same license as the python-docs-theme +# project. +# FIRST AUTHOR , 2025. +# +# Translators: +# NyaPuma , 2025 +# +msgid "" +msgstr "" +"Project-Id-Version: python-docs-theme 2025.10\n" +"Report-Msgid-Bugs-To: https://github.com/python/python-docs-theme/issues\n" +"POT-Creation-Date: 2025-11-24 01:51+0000\n" +"PO-Revision-Date: 2025-09-06 07:41+0000\n" +"Last-Translator: NyaPuma , 2025\n" +"Language-Team: Portuguese (https://app.transifex.com/python-doc/teams/5390/pt/)\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.17.0\n" +"Language: pt\n" +"Plural-Forms: nplurals=3; plural=(n == 0 || n == 1) ? 0 : n != 0 && n % 1000000 == 0 ? 1 : 2;\n" + +#: python_docs_theme/footerdonate.html:1 +msgid "The Python Software Foundation is a non-profit corporation." +msgstr "A Python Software Foundation é uma corporação sem fins lucrativos." + +#: python_docs_theme/footerdonate.html:2 +msgid "Please donate." +msgstr "Por favor, faça uma doação." + +#: python_docs_theme/layout.html:6 +msgid "Navigation" +msgstr "Navegação" + +#: python_docs_theme/layout.html:51 python_docs_theme/layout.html:111 +msgid "Quick search" +msgstr "Pesquisa rápida" + +#: python_docs_theme/layout.html:52 python_docs_theme/layout.html:112 +msgid "Go" +msgstr "Ir" + +#: python_docs_theme/layout.html:60 +msgid "Theme" +msgstr "Tema" + +#: python_docs_theme/layout.html:62 +msgid "Auto" +msgstr "Automático" + +#: python_docs_theme/layout.html:63 +msgid "Light" +msgstr "Claro" + +#: python_docs_theme/layout.html:64 +msgid "Dark" +msgstr "Escuro" + +#: python_docs_theme/layout.html:96 +msgid "Menu" +msgstr "Menu" + +#: python_docs_theme/layout.html:142 +msgid "Copyright" +msgstr "Direitos de autor" + +#: python_docs_theme/layout.html:147 +msgid "" +"This page is licensed under the Python Software Foundation License Version " +"2." +msgstr "" +"Esta página está licenciada sob a Licença da Python Software Foundation " +"Versão 2." + +#: python_docs_theme/layout.html:149 +msgid "" +"Examples, recipes, and other code in the documentation are additionally " +"licensed under the Zero Clause BSD License." +msgstr "" +"Exemplos, receitas e outros códigos na documentação são licenciados " +"adicionalmente sob a licença BSD Zero Clause." + +#: python_docs_theme/layout.html:152 +#, python-format +msgid "" +"See History and License for more " +"information." +msgstr "" +"Consulte Histórico e licença para obter " +"mais informações." + +#: python_docs_theme/layout.html:155 +#, python-format +msgid "Hosted on %(hosted_on)s." +msgstr "Hospedado em %(hosted_on)s." + +#: python_docs_theme/layout.html:163 +#, python-format +msgid "Last updated on %(last_updated)s." +msgstr "Última atualização em %(last_updated)s." + +#: python_docs_theme/layout.html:166 +#, python-format +msgid "Found a bug?" +msgstr "Encontrou um erro?" + +#: python_docs_theme/layout.html:170 +#, python-format +msgid "" +"Created using Sphinx " +"%(sphinx_version)s." +msgstr "" +"Criado usando o Sphinx " +"%(sphinx_version)s." + +#: python_docs_theme/static/copybutton.js:30 +#: python_docs_theme/static/copybutton.js:55 +msgid "Copy" +msgstr "Copiar" + +#: python_docs_theme/static/copybutton.js:31 +msgid "Copy to clipboard" +msgstr "Copiar para a área de transferência" + +#: python_docs_theme/static/copybutton.js:53 +msgid "Copied!" +msgstr "Copiado!" From 2ac4375916835bb3aa1e79c297ecc053fe3b7021 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 10 Dec 2025 17:47:36 +0200 Subject: [PATCH 8/8] Prepare 2025.12 release (#286) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> --- CHANGELOG.md | 8 ++++++++ python_docs_theme/__init__.py | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3221e1b..069a114 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [2025.12](https://github.com/python/python-docs-theme/releases/tag/2025.12) + +* Add support for green, red and yellow side borders for code examples by @hugovk in https://github.com/python/python-docs-theme/pull/285 +* Add Portuguese translation by @NyaPuma in https://github.com/python/python-docs-theme/pull/281 +* Add support for Python 3.15 by @hugovk in https://github.com/python/python-docs-theme/pull/282 +* Convert CHANGELOG and CONTRIBUTING from .rst to .md by @hugovk in https://github.com/python/python-docs-theme/pull/277 +* Add zizmor to CI and fix findings by @hugovk in https://github.com/python/python-docs-theme/pull/283 + ## [2025.10](https://github.com/python/python-docs-theme/releases/tag/2025.10) * Add Romanian translation by @octaG-M in https://github.com/python/python-docs-theme/pull/272 diff --git a/python_docs_theme/__init__.py b/python_docs_theme/__init__.py index e5d1acf..a6c8f18 100644 --- a/python_docs_theme/__init__.py +++ b/python_docs_theme/__init__.py @@ -11,7 +11,7 @@ from sphinx.application import Sphinx from sphinx.util.typing import ExtensionMetadata -__version__ = "2025.10" +__version__ = "2025.12" THEME_PATH = Path(__file__).resolve().parent LOCALE_DIR = THEME_PATH / "locale"