Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update autodoc_pydantic to 2.1.0 #118

Merged
merged 1 commit into from
Mar 18, 2024

Conversation

pyup-bot
Copy link
Collaborator

This PR updates autodoc_pydantic from 2.0.1 to 2.1.0.

Changelog

2.1.0

This is a maintenance and bugfix release extending support to pydantic
v2.6, sphinx v7.2 and python 3.12 while dropping support for python 3.7
which has reached EOL.

Features

-   Hide `model_computed_fields` for pydantic models.
-   Hide `settings_customise_sources` for pydantic settings.

Testing

-   Add pydantic 2.2/2.3/2.4/2.5/2.6 and sphinx 7.1/7.2 and python 3.12
 to test matrix.
-   Remove python 3.7 from test matrix.
-   Remove obsolete `skip ci` condition from github actions.
-   Update `conftest` to use `pathlib` instead of older Sphinx
 `sphinx.testing.path` module that is being deprecated for
 forward-compatibility with newer Sphinx versions.
-   Fix duplicated teset name `test_non_field_attributes`.
-   Add tests to cover inheritance behavior given `inherited-members`
 for field and validator members and summaries.

Bugfix

-   Fix incompatibity with sphinx 7.2 due to changed usage of path
 objects. For more, see
 [11606](https://github.com/sphinx-doc/sphinx/issues/11605).
-   [176](https://github.com/mansenfranzen/autodoc_pydantic/issues/176)
 Remove `sphinxcontrib/__init__.py` causing `ModuleNotFoundError`
 exception in some environments. This should be a namespace package
 per [PEP 420](https://peps.python.org/pep-0420/) without
 `__init_.py` to match with other extensions.
-   Removing deprecation warning `sphinx.util.typing.stringify`.
-   Fix bug a bug while sorting members
 [137](https://github.com/mansenfranzen/autodoc_pydantic/issues/137).

Internal

-   Fix deprecation warning for tuple interface of `ObjectMember` in
 `directives/autodocumenters.py`.
-   Remove obsolete configuration options which have been removed in v2.
-   Introduce `pydantic.options.exists` to check for existence of sphinx
 options.

Documentation

-   Add pydantic to PyPI classifiers to improve discoverability.
-   Correct erdantic installation command in users coniguration section.
-   Improve users FAQ regarding documentation of inherited members.

Contributors

-   Thanks to [devmonkey22](https://github.com/devmonkey22) for
 providing a PR to solve a nasty namespace package issue
 [176](https://github.com/mansenfranzen/autodoc_pydantic/issues/176)
 and [daquinteroflex](https://github.com/daquinteroflex) for testing
 and providing feedback.
-   Thanks to [rafa-guedes](https://github.com/rafa-guedes) for
 providing a PR to fix a deprecation warning for tuple interface of
 `ObjectMember` in `directives/autodocumenters.py`
 [174](https://github.com/mansenfranzen/autodoc_pydantic/issues/174)
 and [j-carson](https://github.com/j-carson) for reporting it.
-   Thanks to [caerulescens](https://github.com/caerulescens) for
 providing a PR to add pydantic to PyPI classifiers
 [179](https://github.com/mansenfranzen/autodoc_pydantic/pull/179).
-   Thanks to [spacemanspiff2007](https://github.com/spacemanspiff2007)
 for hiding `model_computed_fields` and `settings_customise_sources`
 [202](https://github.com/mansenfranzen/autodoc_pydantic/pull/202).
-   Thanks to [tony](https://github.com/tony) for fixing a typo in the
 erdantic docs
 [200](https://github.com/mansenfranzen/autodoc_pydantic/pull/200).
-   Thanks to [j-carson](https://github.com/j-carson) for providing a PR
 that:
 -   fixes a bug while sorting members
     [137](https://github.com/mansenfranzen/autodoc_pydantic/issues/137).
 -   fixes broken CI pipeline with Sphinx 4.\*
 -   removing deprecation warning
     [178](https://github.com/mansenfranzen/autodoc_pydantic/issues/178).
Links

@AndreiDrang AndreiDrang merged commit d56f8a8 into main Mar 18, 2024
3 checks passed
@AndreiDrang AndreiDrang deleted the pyup-update-autodoc_pydantic-2.0.1-to-2.1.0 branch May 21, 2024 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants