sphinx-config-schema 0.0.1__tar.gz

sphinx_config_schema-0.0.1/.cspell.json

@@ -0,0 +1,47 @@
+{
+  "enableFiletypes": [
+    "git-commit",
+    "github-actions-workflow",
+    "julia",
+    "jupyter"
+  ],
+  "flagWords": [
+    "analyse",
+    "colour",
+    "comparision",
+    "favour",
+    "flavour",
+    "hte",
+    "optimise",
+    "paramater",
+    "parmater",
+    "transision",
+    "transisions"
+  ],
+  "ignorePaths": [
+    "**/.cspell.json",
+    "*.ico",
+    ".editorconfig",
+    ".envrc",
+    ".github/dependabot.yml",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+    ".prettierignore",
+    ".vscode/*",
+    "docs/_templates/*",
+    "docs/conf.py",
+    "pyproject.toml"
+  ],
+  "ignoreWords": [
+    "compwa",
+    "prereleased",
+    "pydantic",
+    "pypa",
+    "pypi",
+    "toctree"
+  ],
+  "language": "en-US",
+  "useGitignore": true,
+  "version": "0.2",
+  "words": ["docstrings", "pyproject", "rawsource"]
+}

sphinx_config_schema-0.0.1/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,toml}]
+indent_size = 4
+
+[LICENSE]
+indent_size = unset
+
+[uv.lock]
+indent_size = 4

sphinx_config_schema-0.0.1/.envrc

@@ -0,0 +1,2 @@
+uv sync --all-extras --quiet
+source .venv/bin/activate

sphinx_config_schema-0.0.1/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+
+multi-ecosystem-groups:
+  lock:
+    assignees: [redeboer]
+    commit-message: { prefix: MAINT }
+    schedule: { interval: quarterly }
+
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    labels: [⬆️ Lock]
+    multi-ecosystem-group: lock
+    patterns: ["*"]
+  - package-ecosystem: pre-commit
+    directory: "/"
+    labels: [⬆️ Lock]
+    multi-ecosystem-group: lock
+    patterns: ["*"]

sphinx_config_schema-0.0.1/.github/release-drafter.yml

@@ -0,0 +1,39 @@
+name-template: sphinx-config-schema $NEXT_PATCH_VERSION
+tag-template: $NEXT_PATCH_VERSION
+
+references:
+  - main
+  - epic/*
+
+categories:
+  - title: ✨ New features
+    label: ✨ Feature
+  - title: ⚠️ Enhancements and optimizations
+    label: ⚙️ Enhancement
+  - title: ⚠️ API changes
+    label: ⚠️ Interface
+  - title: ⚠️ Changes that may affect behavior
+    label: ❗ Behavior
+  - title: 🐛 Bug fixes
+    label: 🐛 Bug
+  - title: 📝 Documentation
+    label: 📝 Docs
+  - title: 🔨 Maintenance
+    labels:
+      - 🔨 Maintenance
+      - ⬆️ Lock
+  - title: 🖱️ Developer Experience
+    label: 🖱️ DX
+
+change-template: "- $TITLE (#$NUMBER)"
+
+replacers:
+  - search: /([A-Z]+!?:\s*)(.*)/g
+    replace: $2
+
+sort-direction: ascending
+
+template: |
+  $CHANGES
+
+  _The full changelog as commits can be found [here](https://github.com/ComPWA/sphinx-config-schema/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._

sphinx_config_schema-0.0.1/.github/workflows/cd.yml

@@ -0,0 +1,33 @@
+name: CD
+
+on:
+  release:
+    types:
+      - prereleased
+      - released
+
+jobs:
+  milestone:
+    if: startsWith(github.ref, 'refs/tags')
+    uses: ComPWA/actions/.github/workflows/close-milestone.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+  package-name:
+    uses: ComPWA/actions/.github/workflows/get-pypi-name.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+  pypi:
+    environment:
+      name: PyPI
+      url: https://pypi.org/p/${{ needs.package-name.outputs.name }}
+    if: startsWith(github.ref, 'refs/tags')
+    name: Publish to PyPI
+    needs:
+      - package-name
+    permissions:
+      id-token: write
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: ComPWA/actions/build-pypi-distribution@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+  push:
+    if: startsWith(github.ref, 'refs/tags') && !github.event.release.prerelease
+    permissions:
+      contents: write
+    uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7

sphinx_config_schema-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+on:
+  push:
+    branches:
+      - main
+      - epic/*
+      - "[0-9]+.[0-9]+.x"
+  pull_request:
+    branches:
+      - main
+      - epic/*
+      - "[0-9]+.[0-9]+.x"
+  workflow_dispatch:
+
+jobs:
+  doc:
+    uses: ComPWA/actions/.github/workflows/ci-docs.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+    permissions:
+      pages: write
+      id-token: write
+    with:
+      gh-pages: true
+  style:
+    secrets:
+      token: ${{ secrets.PAT }}
+    uses: ComPWA/actions/.github/workflows/style.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+  test:
+    uses: ComPWA/actions/.github/workflows/test.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+    with:
+      macos-python-version: "3.11"

sphinx_config_schema-0.0.1/.github/workflows/clean-caches.yml

@@ -0,0 +1,22 @@
+name: Clean caches
+
+on:
+  pull_request:
+    types:
+      - closed
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: Clean caches for this branch name or ref
+        required: false
+        type: string
+
+jobs:
+  cleanup:
+    name: Remove caches
+    runs-on: ubuntu-slim
+    steps:
+      - uses: ComPWA/actions/clean-caches@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+        with:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ inputs.ref }}

sphinx_config_schema-0.0.1/.github/workflows/lock.yml

@@ -0,0 +1,21 @@
+name: Update
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+on:
+  pull_request:
+    branches:
+      - main
+      - epic/*
+    paths:
+      - .pre-commit-config.yaml
+  workflow_dispatch:
+
+jobs:
+  lock:
+    uses: ComPWA/actions/.github/workflows/lock.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7
+    secrets:
+      token: ${{ secrets.PAT }}

sphinx_config_schema-0.0.1/.github/workflows/pr-linting.yml

@@ -0,0 +1,14 @@
+name: PR linting
+on:
+  pull_request:
+    types:
+      - edited
+      - labeled
+      - opened
+      - reopened
+      - synchronize
+      - unlabeled
+
+jobs:
+  lint-pr:
+    uses: ComPWA/actions/.github/workflows/pr-linting.yml@483174d7f7f9c0ddbe59643584fdac25004cf887 # v4.1.7

sphinx_config_schema-0.0.1/.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+      - epic/*
+  workflow_dispatch:
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-slim
+    steps:
+      - uses: release-drafter/release-drafter@978bb0b30c5ee8cdd332ced253758157150d43f0 # v7.10.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

sphinx_config_schema-0.0.1/.gitignore

@@ -0,0 +1,25 @@
+__pycache__/
+.agents/
+.claude/
+.codex/
+.coverage
+.coverage.*
+.eggs/
+.fuse_*
+.idea/
+.lycheecache
+.pytest_cache/
+*.egg-info/
+*.pyc
+**.code-workspace
+*build/
+*venv/
+AGENTS.md
+CLAUDE.md
+coverage.xml
+dist/
+htmlcov/
+prof/
+pyvenv*/
+uv.lock
+version.py

sphinx_config_schema-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,83 @@
+ci:
+  autofix_commit_msg: "MAINT: implement pre-commit autofixes"
+  autoupdate_commit_msg: "MAINT: upgrade lock files"
+  autoupdate_schedule: quarterly
+  skip:
+    - tombi-format
+    - tombi-lint
+    - ty
+
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+
+  - repo: https://github.com/ComPWA/policy
+    rev: 0.10.2
+    hooks:
+      - id: check-dev-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.3
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: name-tests-test
+        name: Tests should start with test_
+        args: ["--django"]
+      - id: trailing-whitespace
+
+  - repo: https://github.com/tombi-toml/tombi-pre-commit
+    rev: v1.9.8
+    hooks:
+      - id: tombi-format
+      - id: tombi-lint
+        args: [--error-on-warnings]
+
+  - repo: https://github.com/ComPWA/prettier-pre-commit
+    rev: v3.9.10
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v10.4.0
+    hooks:
+      - id: cspell
+
+  - repo: https://github.com/LilSpazJoekp/docstrfmt
+    rev: v2.2.1
+    hooks:
+      - id: docstrfmt
+
+  - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
+    rev: 3.11.1
+    hooks:
+      - id: editorconfig-checker
+        name: editorconfig
+        alias: ec
+        exclude: >-
+          (?x)^(
+            .*\.py
+          )$
+
+  - repo: https://github.com/astral-sh/ty-pre-commit
+    rev: v0.0.95
+    hooks:
+      - id: ty
+        args: [--group=types, --no-default-groups]

sphinx_config_schema-0.0.1/.prettierignore

@@ -0,0 +1 @@
+LICENSE

sphinx_config_schema-0.0.1/.prettierrc.yml

@@ -0,0 +1,4 @@
+overrides:
+  - files: ["*.schema.json"]
+    options:
+      objectWrap: collapse

sphinx_config_schema-0.0.1/.python-version

@@ -0,0 +1 @@
+3.14

sphinx_config_schema-0.0.1/.vscode/extensions.json

@@ -0,0 +1,32 @@
+{
+  "recommendations": [
+    "astral-sh.ty",
+    "charliermarsh.ruff",
+    "eamodio.gitlens",
+    "esbenp.prettier-vscode",
+    "executablebookproject.myst-highlight",
+    "github.vscode-github-actions",
+    "github.vscode-pull-request-github",
+    "mhutchie.git-graph",
+    "ms-python.python",
+    "ms-vscode.live-server",
+    "soulcode.vscode-unwanted-extensions",
+    "stkb.rewrap",
+    "streetsidesoftware.code-spell-checker",
+    "tombi-toml.tombi"
+  ],
+  "unwantedRecommendations": [
+    "davidanson.vscode-markdownlint",
+    "garaioag.garaio-vscode-unwanted-recommendations",
+    "ms-python.black-formatter",
+    "ms-python.flake8",
+    "ms-python.isort",
+    "ms-python.mypy-type-checker",
+    "ms-python.pylint",
+    "ms-python.vscode-pylance",
+    "ryanluker.vscode-coverage-gutters",
+    "tamasfe.even-better-toml",
+    "travisillig.vscode-json-stable-stringify",
+    "tyriar.sort-lines"
+  ]
+}

sphinx_config_schema-0.0.1/.vscode/settings.json

@@ -0,0 +1,43 @@
+{
+  "[git-commit]": {
+    "editor.rulers": [72],
+    "rewrap.wrappingColumn": 72
+  },
+  "[json]": {
+    "editor.wordWrap": "on"
+  },
+  "[python]": {
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "[toml]": {
+    "editor.defaultFormatter": "tombi-toml.tombi"
+  },
+  "diffEditor.experimental.showMoves": true,
+  "editor.formatOnSave": true,
+  "github-actions.workflows.pinned.workflows": [".github/workflows/ci.yml"],
+  "gitlens.telemetry.enabled": false,
+  "livePreview.defaultPreviewPath": "docs/_build/html",
+  "notebook.codeActionsOnSave": {
+    "notebook.source.organizeImports": "explicit"
+  },
+  "notebook.formatOnSave.enabled": true,
+  "python.defaultInterpreterPath": ".venv/bin/python",
+  "python.terminal.activateEnvironment": false,
+  "python.testing.pytestArgs": ["--numprocesses=auto"],
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false,
+  "redhat.telemetry.enabled": false,
+  "rewrap.wrappingColumn": 88,
+  "ruff.enable": true,
+  "ruff.importStrategy": "fromEnvironment",
+  "ruff.organizeImports": true,
+  "telemetry.telemetryLevel": "off",
+  "testing.coverageToolbarEnabled": true,
+  "testing.showCoverageInExplorer": true,
+  "ty.completions.autoImport": false,
+  "ty.diagnosticMode": "workspace",
+  "ty.importStrategy": "fromEnvironment"
+}

sphinx_config_schema-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ComPWA
+
+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.

sphinx_config_schema-0.0.1/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: sphinx-config-schema
+Version: 0.0.1
+Summary: Render a JSON schema as a copyable TOML, YAML, or JSON example with tooltips in Sphinx
+Author: Common Partial Wave Analysis
+License-Expression: MIT
+Project-URL: Changelog, https://github.com/ComPWA/sphinx-config-schema/releases
+Project-URL: Documentation, https://compwa.github.io/sphinx-config-schema
+Project-URL: Issues, https://github.com/ComPWA/sphinx-config-schema/issues
+Project-URL: Source, https://github.com/ComPWA/sphinx-config-schema
+Keywords: json-schema,sphinx,toml,yaml
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: docutils
+Requires-Dist: pygments
+Requires-Dist: sphinx
+Requires-Dist: sphinx-tippy
+Requires-Dist: typing-extensions
+Dynamic: license-file
+
+# sphinx-config-schema
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![PyPI package](https://badge.fury.io/py/sphinx-config-schema.svg)](https://pypi.org/project/sphinx-config-schema)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-config-schema)](https://pypi.org/project/sphinx-config-schema)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-config-schema/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-config-schema/main)
+[![CI status](https://github.com/ComPWA/sphinx-config-schema/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ComPWA/sphinx-config-schema/actions/workflows/ci.yml?query=branch%3Amain)
+[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+
+`sphinx-config-schema` is a [Sphinx](https://www.sphinx-doc.org) extension that renders a [JSON schema](https://json-schema.org) as a copyable TOML, YAML, or JSON example. Each key shows the description of its setting as a tooltip and links to itself as a permalink.
+
+```bash
+pip install sphinx-config-schema
+```
+
+Then add the extension to your `conf.py`:
+
+```python
+extensions = [
+    "sphinx_config_schema",
+]
+```
+
+and render a schema in a reStructuredText page:
+
+```rst
+.. config-schema:: example.schema.json
+    :caption: pyproject.toml
+    :table: tool.example
+    :format: toml
+```
+
+or in a MyST Markdown page:
+
+````md
+```{config-schema} example.schema.json
+:caption: pyproject.toml
+:table: tool.example
+:format: toml
+```
+````
+
+See [compwa.github.io/sphinx-config-schema](https://compwa.github.io/sphinx-config-schema) for the documentation and a rendered example.

sphinx_config_schema-0.0.1/README.md

@@ -0,0 +1,47 @@
+# sphinx-config-schema
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![PyPI package](https://badge.fury.io/py/sphinx-config-schema.svg)](https://pypi.org/project/sphinx-config-schema)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-config-schema)](https://pypi.org/project/sphinx-config-schema)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-config-schema/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-config-schema/main)
+[![CI status](https://github.com/ComPWA/sphinx-config-schema/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ComPWA/sphinx-config-schema/actions/workflows/ci.yml?query=branch%3Amain)
+[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+
+`sphinx-config-schema` is a [Sphinx](https://www.sphinx-doc.org) extension that renders a [JSON schema](https://json-schema.org) as a copyable TOML, YAML, or JSON example. Each key shows the description of its setting as a tooltip and links to itself as a permalink.
+
+```bash
+pip install sphinx-config-schema
+```
+
+Then add the extension to your `conf.py`:
+
+```python
+extensions = [
+    "sphinx_config_schema",
+]
+```
+
+and render a schema in a reStructuredText page:
+
+```rst
+.. config-schema:: example.schema.json
+    :caption: pyproject.toml
+    :table: tool.example
+    :format: toml
+```
+
+or in a MyST Markdown page:
+
+````md
+```{config-schema} example.schema.json
+:caption: pyproject.toml
+:table: tool.example
+:format: toml
+```
+````
+
+See [compwa.github.io/sphinx-config-schema](https://compwa.github.io/sphinx-config-schema) for the documentation and a rendered example.

sphinx_config_schema-0.0.1/docs/.gitignore

@@ -0,0 +1 @@
+/api/

sphinx_config_schema-0.0.1/docs/_templates/view-on-github.html

@@ -0,0 +1,12 @@
+{# Links to the page source on GitHub, derived from the edit-this-page URL. #}
+{% if sourcename is defined and theme_use_edit_page_button==true and
+page_source_suffix %}
+<div class="tocsection viewongithub">
+  <a
+    href="{{ get_edit_provider_and_url()[1] | replace('/edit/' ~ github_version ~ '/', '/blob/' ~ github_view_rev ~ '/', 1) }}"
+  >
+    <i class="fa-brands fa-github"></i>
+    View on GitHub
+  </a>
+</div>
+{% endif %}