Fix typo in epilog message (.htp -> .hhp)

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/create-release.yml

@@ -0,0 +1,90 @@
+name: Create release
+
+on:
+  push:
+    tags:
+    - "*.*.*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish-pypi:
+    runs-on: ubuntu-latest
+    name: PyPI Release
+    environment: release
+    permissions:
+      id-token: write  # for PyPI trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install build dependencies (pypa/build, twine)
+        run: |
+          pip install -U pip
+          pip install build twine
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Mint PyPI API token
+        id: mint-token
+        uses: actions/github-script@v7
+        with:
+          # language=JavaScript
+          script: |
+            // retrieve the ambient OIDC token
+            const oidc_request_token = process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN;
+            const oidc_request_url = process.env.ACTIONS_ID_TOKEN_REQUEST_URL;
+            const oidc_resp = await fetch(`${oidc_request_url}&audience=pypi`, {
+              headers: {Authorization: `bearer ${oidc_request_token}`},
+            });
+            const oidc_token = (await oidc_resp.json()).value;
+
+            // exchange the OIDC token for an API token
+            const mint_resp = await fetch('https://pypi.org/_/oidc/github/mint-token', {
+              method: 'post',
+              body: `{"token": "${oidc_token}"}` ,
+              headers: {'Content-Type': 'application/json'},
+            });
+            const api_token = (await mint_resp.json()).token;
+
+            // mask the newly minted API token, so that we don't accidentally leak it
+            core.setSecret(api_token)
+            core.setOutput('api-token', api_token)
+
+      - name: Upload to PyPI
+        env:
+          TWINE_NON_INTERACTIVE: "true"
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: "${{ steps.mint-token.outputs.api-token }}"
+        run: |
+          twine check dist/*
+          twine upload dist/*
+
+  github-release:
+    runs-on: ubuntu-latest
+    name: GitHub release
+    environment: release
+    permissions:
+      contents: write  # for softprops/action-gh-release to create GitHub release
+    steps:
+      - uses: actions/checkout@v4
+      - name: Get release version
+        id: get_version
+        uses: actions/github-script@v7
+        with:
+          script: core.setOutput('version', context.ref.replace("refs/tags/", ""))
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          name: "sphinxcontrib-htmlhelp ${{ steps.get_version.outputs.version }}"
+          body: "Changelog: https://github.com/sphinx-doc/sphinxcontrib-htmlhelp/blob/master/CHANGES.rst"

.github/workflows/test.yml

@@ -0,0 +1,91 @@
+name: Test
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+  PYTHONDEVMODE: "1"  # -X dev
+  PYTHONWARNDEFAULTENCODING: "1"  # -X warn_default_encoding
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13-dev"
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v5
+        if: "!endsWith(matrix.python, '-dev')"
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Set up Python ${{ matrix.python }} (deadsnakes)
+        uses: deadsnakes/action@v3.1.0
+        if: "endsWith(matrix.python, '-dev')"
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[standalone,test]
+
+      - name: Test with pytest
+        run: python -m pytest -vv --durations 25
+
+  test-latest-sphinx:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[test]
+          python -m pip install "Sphinx @ git+https://github.com/sphinx-doc/sphinx"
+
+      - name: Test with pytest
+        run: python -m pytest -vv --durations 25
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        env:
+          - ruff
+          - mypy
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade tox
+
+      - name: Run tox
+        run: tox -e ${{ matrix.env }}

.github/workflows/transifex.yml

@@ -0,0 +1,75 @@
+name: Synchronise translations
+
+on:
+  schedule:
+  # 22:38 GMT, every Sunday. Chosen to be a random time.
+  - cron: "38 22 * * SUN"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository_owner == 'sphinx-doc'
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3
+    - name: Install transifex client
+      run: |
+        mkdir -p /tmp/tx_cli && cd $_
+        curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
+      shell: bash
+    - name: Install dependencies
+      run: pip install --upgrade babel jinja2
+    - name: Extract translations from source code
+      run: python utils/babel_runner.py extract
+    - name: Push translations to transifex.com
+      run: |
+        cd sphinxcontrib/htmlhelp/locales 
+        /tmp/tx_cli/tx push --source --use-git-timestamps --workers 10
+      env:
+        TX_TOKEN: ${{ secrets.TX_TOKEN }}
+
+  pull:
+    permissions:
+      contents: write  # for peter-evans/create-pull-request to create branch
+      pull-requests: write  # for peter-evans/create-pull-request to create a PR
+    if: github.repository_owner == 'sphinx-doc'
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3
+    - name: Install transifex client
+      run: |
+        mkdir -p /tmp/tx_cli && cd $_
+        curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
+      shell: bash
+    - name: Install dependencies
+      run: pip install --upgrade babel jinja2
+    - name: Extract translations from source code
+      run: python utils/babel_runner.py extract
+    - name: Pull translations from transifex.com
+      run: |
+        cd sphinxcontrib/htmlhelp/locales 
+        /tmp/tx_cli/tx pull --translations --all --force --use-git-timestamps --workers 10
+      env:
+        TX_TOKEN: ${{ secrets.TX_TOKEN }}
+    - name: Compile message catalogs
+      run: python utils/babel_runner.py compile
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v6
+      with:
+        commit-message: "[internationalisation] Update translations"
+        branch: bot/pull-translations
+        title: "[bot]: Update message catalogues"
+        labels: "internals:internationalisation"

.gitignore

@@ -1,13 +1,17 @@
 *.pyc
-*.egg
-*.so
-*.swp
 
 .DS_Store
+idea/
+.vscode/
+
 .mypy_cache/
+.pytest_cache/
+.ruff_cache/
 .tags
 .tox/
 
+.venv/
+venv/
+
 build/
 dist/
-sphinxcontrib_htmlhelp.egg-info/

.ruff.toml

@@ -0,0 +1,53 @@
+target-version = "py39"  # Pin Ruff to Python 3.9
+output-format = "full"
+line-length = 95
+
+[lint]
+preview = true
+select = [
+#    "ANN",   # flake8-annotations
+    "C4",    # flake8-comprehensions
+    "COM",   # flake8-commas
+    "B",     # flake8-bugbear
+    "DTZ",   # flake8-datetimez
+    "E",     # pycodestyle
+    "EM",    # flake8-errmsg
+    "EXE",   # flake8-executable
+    "F",     # pyflakes
+    "FA",    # flake8-future-annotations
+    "FLY",   # flynt
+    "FURB",  # refurb
+    "G",     # flake8-logging-format
+    "I",     # isort
+    "ICN",   # flake8-import-conventions
+    "INT",   # flake8-gettext
+    "LOG",   # flake8-logging
+    "PERF",  # perflint
+    "PGH",   # pygrep-hooks
+    "PIE",   # flake8-pie
+    "PT",    # flake8-pytest-style
+    "SIM",   # flake8-simplify
+    "SLOT",  # flake8-slots
+    "TCH",   # flake8-type-checking
+    "UP",    # pyupgrade
+    "W",     # pycodestyle
+    "YTT",   # flake8-2020
+]
+ignore = [
+    "E116",
+    "E241",
+    "E251",
+]
+
+[lint.per-file-ignores]
+"tests/*" = [
+    "ANN",  # tests don't need annotations
+]
+
+[lint.isort]
+forced-separate = [
+    "tests",
+]
+required-imports = [
+    "from __future__ import annotations",
+]