Autodoc Pydantic Versions Save

Seamlessly integrate pydantic models in your Sphinx documentation.

v2.2.0

3 weeks ago

2.2.0 (2024-04-26)

✨ Features

  • Allow empty strings for directive prefixes (#285) (be21d37)
  • Remove duplicated docs strings when use_attribute_docstrings is used in pydantic >= 2.7 (#276) (0ddb12f)

🐛 Bug Fixes

  • deps: update dependency erdantic to <v2 (#246) (3c8daa8)
  • deps: update dependency erdantic to ^0.7.0 (#226) (0909963)
  • deps: update dependency flake8 to v7 (#233) (c270e8a)
  • deps: update dependency pytest to v8 (#234) (8b330af)
  • deps: update dependency sphinx-copybutton to ^0.5.0 (#227) (7ada937)
  • deps: update dependency sphinx-rtd-theme to v2 (#235) (f43cfa9)
  • deps: update dependency sphinxcontrib-mermaid to ^0.9.0 (#229) (984ce05)
  • Improve error message for _sort_summary_list failures (#243) (87923a1)
  • Test please-release (d4595bf)
  • Use more precise name instead of object_name for _sort_summary_list error msg (#244) (42bdd4b)

⛏ Other Changes

  • Add changelog-sections to please-release (#218) (5355f98)
  • Add refactor and more categories to release-please configuration. (#258) (71e1c60)
  • Add Coduim PR Agent Workflow (#236) (38f9e16)
  • Configure Renovate (#225) (efc2f9a)
  • Deactivate dependency dashboard (#238) (11afaf3)
  • deps: update abatilo/actions-poetry action to v3 (#230) (be248a4)
  • deps: update actions/checkout action to v4 (#231) (5774bdf)
  • deps: update actions/setup-python action to v5 (#232) (2bc973b)
  • fix link in all-contributors bot (#281) (8261254)
  • improve changelog (b22840f)
  • Remove dev extras and tox from pyproject.toml (204f246)
  • Remove dependabot in favor for Mend's renovate (#267) (9726cc5)
  • Revert all-contributors commit type (#282) [skip ci] (c4c8fe7)
  • Use ruff for linting and formatting (#242) (461be30)

📖 Documentation

  • add exs-dwoodward as a contributor for code (#250) (532b54f)
  • Add hint mentioning that pydantic directive prefixes allow empty strings (be21d37)
  • Add missing erdantic version number (#224) (4c9c6b2)
  • Fix broken link in example section (40b5b22)
  • Improve README.md with update badges and remove animated gif comparison examples (40b5b22)
  • improve erdantic example (3c8daa8)
  • Recommend globally installed tox instead of poetry installed tox (#223) (204f246)
  • Remove pydantic v1/v2 branch note from developer setup guide (204f246)
  • Replace Sphinx index.rst with repo's README.md (#270) (40b5b22)
  • Use myst_parser to include CHANGELOG.md instead of rst (#245) (e6fe9e1)

🚀 CI/CD Pipeline

  • Add pip-audit security scanner (#268) (0be2710)
  • Add daily scheduled GH workflow with test for pre-release versions (#265) (a4c5140)
  • Add dependabot configuration (#248) (dc0a81d)
  • Add explicit pydantic_settings versions to prevent unwanted pydantic version upgrades in CI matrix (#263) (2c5c4d5)
  • Add pydantic 2.7 to test matrix (#253) (afdec96)
  • fix broken tox environment naming convention preventing correct version selection (134c3cb)
  • Fix incorrect tox env name for security scans (#271) (bcb9ee0)
  • Ignore release-please branches for CI tests (#221) (5f4c0dc)
  • Integrate mypy type checking (#259) (134c3cb)
  • Move publish step into release-please workflow (#237) (0864395)
  • Protect workflows via CODEOWNERS and explicit user matching (#240) (c07d1f2)
  • Refactor CI with resusable, custom GitHub Action (#252) (0d582c7)
  • Replace flake8 with ruff for linting/formatting (461be30)
  • Streamline GH workflow names (0be2710)
  • Support pydantic 2.7 and sphinx 7.3 (#261) (a797a77)
  • Update codcov GH action to newest version (#219) (b129602)
  • Update GH Actions to newest Versions (#222) (5a21c2a)

🔧 Testing

  • Fix warnings due to deprecated test examples (#273) (65ed9cc)
  • remove package_is_missing (3c8daa8)
  • Remove obsolete test classes (65ed9cc)
  • simplify erdantic tests (3c8daa8)

🔨 Refactoring

  • Move extension setup logic into seperate application module (#264) (e8f7f06)
  • rename PydanticDirectiveBase to PydanticDirectiveMixin for better clarity (134c3cb)
  • restructure sphinx app cfg values in __init__ (134c3cb)

⬆️ Dependency Updates

👥 Contributors

  • add annerademacher as a contributor for financial (#284) (80cf3e9)
  • add azmeuk as a contributor for bug (#286) (36056f7)
  • add bruno-f-cruz as a contributor for bug (#280) (47e98df)
  • add Carson-Shaar as a contributor for bug (#278) [skip ci] (bc4cdb6)
  • add Galarzaa90 as a contributor for bug (#277) (15cead4)
  • add ITProKyle as a contributor for bug (#279) [skip ci] (2a899f1)
  • add lwasser as a contributor for bug (#262) (83d2b94)