sphinx-section-include 2026.11.1__tar.gz

sphinx_section_include-2026.11.1/.git_archival.txt

@@ -0,0 +1 @@
+ref-names: $Format:%D$

sphinx_section_include-2026.11.1/.gitattributes

@@ -0,0 +1,3 @@
+.git_archival.txt  export-subst
+* text=auto eol=lf
+*.rst conflict-marker-size=32

sphinx_section_include-2026.11.1/.github/dependabot.yml

@@ -0,0 +1,23 @@
+---
+version: 2
+
+updates:
+  - package-ecosystem: pip
+    allow:
+      - dependency-type: all
+    directory: /
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    # doc8 caps Docutils at 0.21.2, and doccmd's MyST dependency caps it below 0.23.
+    # Remove this ignore when both tools support newer Docutils versions.
+    ignore:
+      - dependency-name: docutils
+        versions: ['>0.21.2']
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+
+  # Dependabot cannot read prek.toml yet:
+  # https://github.com/dependabot/dependabot-core/issues/14624

sphinx_section_include-2026.11.1/.github/workflows/autofix.yml

@@ -0,0 +1,36 @@
+---
+name: autofix.ci
+
+on:
+  pull_request: {}
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  autofix:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+
+      - name: Run fixers
+        uses: j178/prek-action@v3.1.0
+        with:
+          prek-version: 0.5.7
+          extra-args: >-
+            --all-files --hook-stage pre-commit --no-fail-fast --verbose
+        env:
+          UV_NO_CACHE: '1'
+          UV_PYTHON: 3.13
+
+      - uses: autofix-ci/action@v1.3.4
+        if: always()

sphinx_section_include-2026.11.1/.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+---
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    # Run at 1:00 every day
+    - cron: 0 1 * * *
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        python-version: ['3.12', '3.13', '3.14', '3.15']
+        uv-resolution: [highest, lowest-direct]
+        platform: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - uses: actions/checkout@v7
+
+        with:
+          persist-credentials: false
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
+
+      - name: Build sample
+        run: |
+          uv run --group=dev sphinx-build -W -b html sample/source sample/build
+        env:
+          UV_PYTHON: ${{ matrix.python-version }}
+          UV_RESOLUTION: ${{ matrix.uv-resolution }}
+
+      - name: Build sample parallel
+        run: |
+          uv run --group=dev sphinx-build -j 2 -E -W -b html sample/source sample/build-parallel
+        env:
+          UV_PYTHON: ${{ matrix.python-version }}
+          UV_RESOLUTION: ${{ matrix.uv-resolution }}
+
+      - name: Run tests
+        run: |
+          uv run --group=dev pytest -s -vvv . --cov --cov-config=pyproject.toml
+        env:
+          UV_PYTHON: ${{ matrix.python-version }}
+          UV_RESOLUTION: ${{ matrix.uv-resolution }}
+
+      - name: Build distributions and test the installed wheel
+        run: |
+          uv build
+          uv run --group=release check-wheel-contents dist/*.whl
+          uv run --group=dev python tests/wheel_smoke.py
+        env:
+          UV_PYTHON: ${{ matrix.python-version }}
+          UV_RESOLUTION: ${{ matrix.uv-resolution }}
+
+  completion-ci:
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ !cancelled() }}
+    steps:
+      - name: Check matrix job status
+        run: |-
+          if ! ${{ needs.build.result == 'success' }}; then
+            echo "One or more CI jobs failed"
+            exit 1
+          fi

sphinx_section_include-2026.11.1/.github/workflows/dependabot-merge.yml

@@ -0,0 +1,19 @@
+---
+
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]'
+    steps:
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

sphinx_section_include-2026.11.1/.github/workflows/lint.yml

@@ -0,0 +1,61 @@
+---
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    # Run at 1:00 every day
+    - cron: 0 1 * * *
+  workflow_dispatch: {}
+
+permissions: {}
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        python-version: ['3.13']
+        platform: [ubuntu-latest, windows-latest]
+        hook-stage: [pre-commit, pre-push, manual]
+
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
+
+      - name: Lint
+        uses: j178/prek-action@v3.1.0
+        with:
+          prek-version: 0.5.7
+          extra-args: >-
+            --all-files --hook-stage ${{ matrix.hook-stage }} --verbose
+        env:
+          UV_NO_CACHE: '1'
+          UV_PYTHON: ${{ matrix.python-version }}
+          # UV_RESOLUTION is intentionally not set here. prek uses uv to
+          # install hooks, and uv inherits UV_RESOLUTION. With lowest-direct,
+          # this causes hook dependencies to resolve to ancient versions that
+          # don't build on modern Python.
+
+  completion-lint:
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ !cancelled() }}
+    steps:
+      - name: Check matrix job status
+        run: |-
+          if ! ${{ needs.build.result == 'success' }}; then
+            echo "One or more matrix jobs failed"
+            exit 1
+          fi

sphinx_section_include-2026.11.1/.github/workflows/release.yml

@@ -0,0 +1,89 @@
+---
+name: Release
+
+on: workflow_dispatch
+
+permissions: {}
+
+jobs:
+  build:
+    name: Publish a release
+    runs-on: ubuntu-latest
+
+    # Specifying an environment is strongly recommended by PyPI.
+    # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
+    if: vars.PYPI_PUBLISH_ENABLED == 'true'
+    environment: release
+
+    permissions:
+      # This is needed for PyPI publishing.
+      # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
+      id-token: write
+      # This is needed to create the release tag and upload distributions.
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          # Fetch all history and tags for version calculation.
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
+
+      - name: Calver calculate version
+        uses: StephaneBour/actions-calver@master
+        id: calver
+        with:
+          date_format: '%Y.%m.%d'
+          release: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Read the reviewed release notes
+        env:
+          RELEASE: ${{ steps.calver.outputs.release }}
+        run: |
+          test -f "changelog/$RELEASE.md"
+          cp "changelog/$RELEASE.md" release-notes.md
+
+      - name: Bump version and push tag
+        id: tag_version
+        uses: mathieudutour/github-tag-action@v7
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          custom_tag: ${{ steps.calver.outputs.release }}
+          tag_prefix: ''
+          commit_sha: ${{ github.sha }}
+
+      - name: Build a binary wheel and a source tarball
+        env:
+          NEW_TAG: ${{ steps.tag_version.outputs.new_tag }}
+        run: |
+          git fetch --tags
+          git checkout "$NEW_TAG"
+          uv build --sdist --wheel --out-dir dist/
+          uv run --group=release check-wheel-contents dist/*.whl
+
+      - name: Test the installed wheel
+        run: uv run --group=dev python tests/wheel_smoke.py
+
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          makeLatest: true
+          name: Release ${{ steps.tag_version.outputs.new_tag }}
+          bodyFile: release-notes.md
+          artifacts: dist/*
+          artifactErrorsFailBuild: true
+
+      # We use PyPI trusted publishing rather than a PyPI API token.
+      # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

sphinx_section_include-2026.11.1/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# direnv file
+ .envrc
+
+  # IDEA ide
+ .idea/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# setuptools_scm
+src/*/_setuptools_scm_version.txt
+
+
+# Ignore Mac DS_Store files
+.DS_Store
+**/.DS_Store
+
+# Vale styles downloaded by ``vale sync``
+styles/*
+!styles/snapper/
+
+.ruff_cache/
+.ty_cache/
+sample/build/
+
+# Dependency locks are application-specific.
+uv.lock

sphinx_section_include-2026.11.1/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "overrides": [
+    {
+      "files": ["*.yaml", "*.yml"],
+      "options": {
+        "singleQuote": true,
+        "printWidth": 100
+      }
+    }
+  ]
+}

sphinx_section_include-2026.11.1/.vale.ini

@@ -0,0 +1,13 @@
+StylesPath = styles
+MinAlertLevel = error
+
+Packages = https://github.com/tbhb/vale-ai-tells/releases/download/v1.29.0/ai-tells.zip
+
+[*.{rst,md}]
+BasedOnStyles = ai-tells, snapper
+snapper.SemanticLineBreaks = error
+
+# These rules misclassify established technical, example, or release-note prose
+# in this repository. All other ai-tells rules remain enforced.
+ai-tells.FormalTransitions = NO
+ai-tells.VerbTricolon = NO

sphinx_section_include-2026.11.1/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff",
+        "ms-python.python"
+    ]
+}

sphinx_section_include-2026.11.1/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnSave": true
+    },
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

sphinx_section_include-2026.11.1/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Release notes are in [changelog/](changelog/).

sphinx_section_include-2026.11.1/CONTRIBUTING.rst

@@ -0,0 +1,121 @@
+Contributing
+============
+
+Contributions to this repository must pass tests and linting.
+
+CI is the canonical source of truth.
+
+Install contribution dependencies
+---------------------------------
+
+Install Python dependencies in a virtual environment.
+
+.. code-block:: shell
+
+   uv sync --group=dev
+
+Spell checking requires ``enchant``.
+This can be installed on macOS, for example, with `Homebrew`_:
+
+.. code-block:: shell
+
+   brew install enchant
+
+and on Ubuntu with ``apt``:
+
+.. code-block:: shell
+
+   apt-get install -y enchant
+
+Install ``pre-commit`` hooks:
+
+.. code-block:: shell
+
+   uv run --group=dev prek install
+
+Linting
+-------
+
+Run lint tools either by committing, or with:
+
+.. code-block:: shell
+
+   uv run --group=dev prek run --all-files --hook-stage pre-commit --verbose
+   uv run --group=dev prek run --all-files --hook-stage pre-push --verbose
+   uv run --group=dev prek run --all-files --hook-stage manual --verbose
+
+.. _Homebrew: https://brew.sh
+
+Running tests
+-------------
+
+Run ``pytest``:
+
+.. code-block:: shell
+
+   uv run --group=dev pytest --cov --cov-config=pyproject.toml
+
+Continuous integration
+----------------------
+
+Tests are run on GitHub Actions.
+The configuration is in ``.github/workflows/``.
+CI builds the sample with serial and parallel Sphinx readers, runs tests with 100% branch coverage, and builds distributions.
+It also installs the wheel and builds the sample outside the checkout.
+The test matrix covers Python 3.12 through 3.15 on Ubuntu and Windows with highest and lowest direct dependencies.
+
+Run the sample and packaging checks locally:
+
+.. code-block:: shell
+
+   uv run --group=dev sphinx-build -W -b html sample/source sample/build
+   uv build
+   uv run --group=release check-wheel-contents dist/*.whl
+   uv run --group=dev python tests/wheel_smoke.py
+
+Release Process
+---------------
+
+Outcomes
+~~~~~~~~
+
+* A new ``git`` tag available to install.
+* A new package on PyPI.
+
+Perform a Release
+~~~~~~~~~~~~~~~~~
+
+Versions come from Git tags through ``setuptools-scm``.
+The release workflow tags the reviewed commit and uses PyPI trusted publishing with the ``release`` environment.
+Configure the trusted publisher and set ``PYPI_PUBLISH_ENABLED`` to ``true`` before dispatching a release.
+
+#. `Install GitHub CLI`_.
+
+#. Prepare release notes for the next CalVer version in a pull request.
+   Use the current date and increment the final numeric suffix for another release on the same date:
+
+   .. code-block:: shell
+
+      uv run --group=release towncrier build --yes --version 2026.10.30.2
+      uv run --group=dev snapper --native --max-width 0 --in-place changelog/2026.10.30.2.md
+
+   Commit the generated changelog and removed fragments, then merge after the required checks pass.
+
+#. Dispatch the release from ``main``:
+
+   .. code-block:: shell
+
+      gh workflow run release.yml --repo adamtheturtle/sphinx-section-include
+
+   The workflow calculates the next version and requires its changelog file to exist.
+   It creates the tag and distributions without pushing a new commit to ``main``.
+
+.. _Install GitHub CLI: https://cli.github.com/manual/installation
+
+
+Release notes
+-------------
+
+Write user-facing changes as Markdown in ``newsfragments/<issue>.change.md``.
+Towncrier writes one Markdown file per version, used directly for GitHub release notes.
+Invalid fragment names fail release assembly.

sphinx_section_include-2026.11.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rippling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.