Merge branch 'main' into fix_doc

Author: AA-Turner

.github/workflows/create-release.yml

@@ -0,0 +1,55 @@
+name: Create release
+
+on:
+  push:
+    tags:
+    - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+  UV_SYSTEM_PYTHON: "1"  # make uv do global installs
+
+jobs:
+  publish-pypi:
+    runs-on: ubuntu-latest
+    name: PyPI Release
+    environment: release
+    if: github.repository_owner == 'breathe-doc'
+    permissions:
+      id-token: write  # for PyPI trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: latest
+          enable-cache: false
+
+      - name: Install build dependencies (pypa/build, twine)
+        run: uv pip install build "twine>=5.1"
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Check distribution
+        run: |
+          twine check --strict dist/*
+
+      - name: Upload to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.rst

@@ -128,13 +128,11 @@ Examples of projects that use Breathe:
 Release
 -------
 
-See the ``mkrelease`` utility in the root of the repository.
-
-Useful vim command for changelog conversion to the git tag format:
-
-.. code:: vim
-
-   %s/\v`(#[0-9]+) \<[^`]*`__/\1/g
+1. Update `CHANGELOG.rst` and create the git tag (`vX.Y.Z`).
+2. Push the tag to GitHub.
+3. The `create-release.yml` workflow will publish the release to PyPI.
+4. Go to https://github.com/breathe-doc/breathe/tags, select the new tag,
+   and click the "Create release from tag" button to publish a GitHub release.
 
 Maintainers
 -----------