sphinxcontrib-pydantic 0.1.0__tar.gz

sphinxcontrib_pydantic-0.1.0/.codecov.yaml

@@ -0,0 +1,25 @@
+comment: false
+github_checks:  # too noisy, even though "a" interactively disables them
+  annotations: false
+
+codecov:
+  notify:
+    require_ci_to_pass: false
+
+coverage:
+  status:
+    patch:
+      default:
+        informational: true
+        target: 95%
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: error
+    project:
+      default: false
+      library:
+        informational: true
+        target: 90%
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: error

sphinxcontrib_pydantic-0.1.0/.github/dependabot.yaml

@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

sphinxcontrib_pydantic-0.1.0/.github/release.yaml

@@ -0,0 +1,7 @@
+changelog:
+  exclude:
+    authors:
+      - autofix-ci[bot]
+      - dependabot[bot]
+      - github-actions[bot]
+      - pre-commit-ci[bot]

sphinxcontrib_pydantic-0.1.0/.github/workflows/bot.yaml

@@ -0,0 +1,24 @@
+name: bot
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+  schedule:
+    - cron: '0 3 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  auto-merge:
+    if: ${{ github.repository == 'mscheltienne/sphinxcontrib-pydantic' && github.event_name == 'pull_request' && (github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'pre-commit-ci[bot]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Enable auto-merge for bot PRs
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

sphinxcontrib_pydantic-0.1.0/.github/workflows/examples.yaml

@@ -0,0 +1,47 @@
+name: examples
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+  schedule:
+    - cron: '0 8 * * 1'
+
+env:
+  UV_LOCKED: true
+
+jobs:
+  build:
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        python-version: ["3.13"]
+    name: ${{ matrix.os }} - py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v7
+        with:
+          activate-environment: true
+          python-version: ${{ matrix.python-version }}
+      - run: |
+          uv sync -q --no-default-groups --group example
+          uv pip install -e examples/basic/
+          uv pip install -e examples/advanced/
+          uv pip install -e examples/autosummary/
+      - name: Build basic example
+        run: make -C examples/basic/doc html
+      - name: Build advanced example
+        run: make -C examples/advanced/doc html
+      - name: Build autosummary example
+        run: make -C examples/autosummary/doc html

sphinxcontrib_pydantic-0.1.0/.github/workflows/publish.yaml

@@ -0,0 +1,24 @@
+name: publish
+on:  # yamllint disable-line rule:truthy
+  release:
+    types: [published]
+
+jobs:
+  pypi:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v7
+      - run: uv build
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          tag_name: ${{ github.event.release.tag_name }}
+      - run: uv publish --trusted-publishing always

sphinxcontrib_pydantic-0.1.0/.github/workflows/pytest.yaml

@@ -0,0 +1,69 @@
+name: pytest
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+  schedule:
+    - cron: '0 8 * * 1'
+
+env:
+  UV_LOCKED: true
+
+jobs:
+  pytest:
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos, windows]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    name: ${{ matrix.os }} - py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v7
+        with:
+          activate-environment: true
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync -q --no-default-groups --group test
+      - run: pytest tests --cov=sphinxcontrib.pydantic --cov-report=xml --cov-config=pyproject.toml
+      - uses: codecov/codecov-action@v5
+        if: ${{ github.repository == 'mscheltienne/sphinxcontrib-pydantic' }}
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  pytest-pip-pre:
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+    name: pip pre-release - py${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v7
+        with:
+          activate-environment: true
+          python-version: ${{ matrix.python-version }}
+      - name: Install package
+        run: |
+          uv sync -q --no-default-groups --group test
+          uv pip install -q --upgrade --prerelease allow git+https://github.com/pydantic/pydantic
+          uv pip install -q --upgrade --prerelease allow git+https://github.com/sphinx-doc/sphinx
+      - run: pytest tests --cov=template --cov-report=xml --cov-config=pyproject.toml
+      - uses: codecov/codecov-action@v5
+        if: ${{ github.repository == 'mscheltienne/sphinxcontrib-pydantic' }}
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

sphinxcontrib_pydantic-0.1.0/.gitignore

@@ -0,0 +1,136 @@
+# macOS
+.DS_Store
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+junit-results.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/_build/
+doc/generated/
+doc/api/generated/
+
+# Example package documentation builds
+examples/**/doc/_build/
+examples/**/doc/generated/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# PyCharm
+**/.idea/
+
+# VSCode
+.vscode
+
+# Ruff
+.ruff_cache
+
+# Version file generated by setuptools
+_version.py

sphinxcontrib_pydantic-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+    - repo: https://github.com/astral-sh/uv-pre-commit
+      rev: 0.9.26
+      hooks:
+          - id: uv-lock
+
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.14.14
+      hooks:
+          - id: ruff
+            name: ruff linter
+            args: [--fix, --show-fixes]
+          - id: ruff-format
+            name: ruff formatter
+
+    - repo: https://github.com/codespell-project/codespell
+      rev: v2.4.1
+      hooks:
+          - id: codespell
+            additional_dependencies: [tomli]
+
+    - repo: https://github.com/pappasam/toml-sort
+      rev: v0.24.3
+      hooks:
+          - id: toml-sort-fix
+            files: pyproject.toml
+
+    - repo: https://github.com/adrienverge/yamllint
+      rev: v1.38.0
+      hooks:
+          - id: yamllint
+            args: [--strict, -c, .yamllint.yaml]
+            files: (.github/|.codecov.yaml|.pre-commit-config.yaml|.yamllint.yaml)

sphinxcontrib_pydantic-0.1.0/.yamllint.yaml

@@ -0,0 +1,5 @@
+extends: default
+
+rules:
+  line-length: disable
+  document-start: disable

sphinxcontrib_pydantic-0.1.0/LICENSE

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

sphinxcontrib_pydantic-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: sphinxcontrib-pydantic
+Version: 0.1.0
+Summary: A simple integration between autodoc and Pydantic in your Sphinx documentation.
+Author-email: Mathieu Scheltienne <mathieu.scheltienne@gmail.com>
+Maintainer-email: Mathieu Scheltienne <mathieu.scheltienne@gmail.com>
+License-Expression: MIT
+Project-URL: source, https://github.com/mscheltienne/sphinxcontrib-pydantic
+Project-URL: tracker, https://github.com/mscheltienne/sphinxcontrib-pydantic/issues
+Keywords: autodoc,pydantic,python,sphinx
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: docutils
+Requires-Dist: pydantic-core
+Requires-Dist: pydantic>=2.0
+Requires-Dist: sphinx>=9.0
+Provides-Extra: settings
+Requires-Dist: pydantic-settings>=2.0; extra == "settings"
+Dynamic: license-file
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![codecov](https://codecov.io/gh/mscheltienne/sphinxcontrib-pydantic/graph/badge.svg?token=AC0qhhaeVW)](https://codecov.io/gh/mscheltienne/sphinxcontrib-pydantic)
+[![tests](https://github.com/mscheltienne/sphinxcontrib-pydantic/actions/workflows/pytest.yaml/badge.svg?branch=main)](https://github.com/mscheltienne/sphinxcontrib-pydantic/actions/workflows/pytest.yaml)
+
+# sphinxcontrib-pydantic
+
+A Sphinx extension for documenting Pydantic models in your documentation.
+
+This project was inspired by [autodoc_pydantic](https://github.com/mansenfranzen/autodoc_pydantic),
+which I have been using for years but has gone unmaintained and is now incompatible
+with **Sphinx 9.0+**. Unlike its predecessor, `sphinxcontrib-pydantic` focuses
+exclusively on modern versions: **Pydantic v2+** and **Sphinx 9.0+** (Python 3.11+).
+
+This project was vibe-coded using Claude Code (Opus 4.5); using `autodoc_pydantic` as
+inspiration as well as the source code of `sphinx` and `pydantic` as documentation.
+
+## Installation
+
+```bash
+pip install sphinxcontrib-pydantic
+```
+
+For `pydantic-settings` support:
+
+```bash
+pip install sphinxcontrib-pydantic[settings]
+```
+
+## Configuration
+
+Enable the extension in your `conf.py`:
+
+```python
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinxcontrib.pydantic",
+]
+```
+
+## Usage
+
+### With autodoc
+
+The extension integrates with `sphinx.ext.autodoc`. Simply use `automodule` or
+`autoclass`:
+
+```rst
+.. automodule:: mypackage.models
+   :members:
+```
+
+Pydantic models are automatically detected and documented with field summaries and
+validators.
+
+### With autosummary
+
+For larger projects, use `autosummary` with a custom template:
+
+```rst
+.. currentmodule:: mypackage.models
+
+.. autosummary::
+   :toctree: generated/api
+   :template: autosummary/models.rst
+
+   UserConfig
+   DatabaseConfig
+```
+
+Create `_templates/autosummary/models.rst`:
+
+```jinja
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. pydantic-model:: {{ fullname }}
+   :inherited-members: BaseModel
+```
+
+### Standalone directives
+
+Document models directly with the `pydantic-model` directive:
+
+```rst
+.. pydantic-model:: mypackage.models.UserConfig
+   :show-field-summary:
+   :show-validator-summary:
+```
+
+For Pydantic settings:
+
+```rst
+.. pydantic-settings:: mypackage.settings.AppSettings
+   :show-field-summary:
+```
+
+## Configuration Options
+
+All options use the `sphinxcontrib_pydantic_` prefix in `conf.py`, e.g.
+`sphinxcontrib_pydantic_model_show_json`.
+
+### Model Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `model_show_json` | `False` | Show JSON schema for the model |
+| `model_show_field_summary` | `True` | Show summary table of fields |
+| `model_show_validator_summary` | `True` | Show summary table of validators |
+| `model_show_config` | `False` | Show model configuration |
+| `model_signature_prefix` | `"model"` | Prefix shown before model name |
+| `model_hide_paramlist` | `True` | Hide `__init__` parameter list |
+
+### Field Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `field_show_alias` | `True` | Show field aliases |
+| `field_show_default` | `True` | Show default values |
+| `field_show_required` | `True` | Show required status |
+| `field_show_constraints` | `True` | Show field constraints (e.g., `min_length`) |
+
+### Validator Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `validator_list_fields` | `True` | List fields affected by each validator |
+
+### Settings Options
+
+Settings options mirror model options with `settings_` prefix (e.g.,
+`sphinxcontrib_pydantic_settings_show_json`).
+They default to the same values as their model counterparts.
+
+### Example Configuration
+
+```python
+# conf.py
+sphinxcontrib_pydantic_model_show_json = True
+sphinxcontrib_pydantic_model_show_field_summary = True
+sphinxcontrib_pydantic_field_show_constraints = True
+sphinxcontrib_pydantic_settings_signature_prefix = "config"
+```