This is a feature release adding support for entity relationship diagrams
while dropping python 3.6. Additionally, pydantic v2 is currently excluded
until support will be added. Moreover, newest sphinx versions are
added to test matrix.
Feature
- Introduce ``erdantic-figure`` and ``erdantic-figure-collapsed`` configuration
option for pydantic models to add entity relationship diagrams to models'
documentation either in collapsed form or as an image included to the HTML.
`[#148](https://github.com/mansenfranzen/autodoc_pydantic/issues/148) <https://github.com/mansenfranzen/autodoc_pydantic/pull/148>`__.
Bugfix
- Run github actions on newest ``ubuntu-22.04``.
- Fix pytest errors with ``sphinx>=6.1`` where the type returned by
``autodoc_typehints_format`` changed.
- Provide upper version boundary for pydantic to exclude v2 which
is not supported, yet.
Internal
</code></pre>
<ul>
<li>Add <code>to_collapsable</code> to <code>directives.templates</code> that provides a
standardized interface to create a collapsable field.</li>
<li>Add <code>erdantic</code> to extras dependencies.</li>
</ul>
<p>Documentation</p>
<pre><code>
- Add descriptions for ``erdantic-figure`` and ``erdantic-figure-collapsed``
options in the configuration section.
- Add an example of ERD in the example section.
Testing
Exclude python 3.6 in test matrix.
Include sphinx 6.0, 6.1, 6.2 and 7.0 in test matrix.
Add tests for erdantic-figure and erdantic-figure-collapsed.
Fix github actions CI pipeline due to unsupported ubuntu while upgrading to
newest ubuntu-22.04.
Contributors
</tr></table>
</code></pre>
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/10434f76f8abb9faee39eab8f5baf3a7deca558c"><code>10434f7</code></a> Fix poetry urllib issue.</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/ff0838f4921239e473215b5ad1ee81b6ea4e69e6"><code>ff0838f</code></a> Merge pull request <a href="https://redirect.github.com/mansenfranzen/autodoc_pydantic/issues/155">#155</a> from mansenfranzen/all-contributors/add-tkaraouzene</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/fd83255a8a4808cc4bcc02f825bbbbc28a92c626"><code>fd83255</code></a> Add upper pydantic boundary.</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/4371c292f4b8f5fe7a735266eb0726f5fb1a5f5c"><code>4371c29</code></a> Add contributor.</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/97558522dd0e4f3ad603ef29227ed6939a436774"><code>9755852</code></a> docs: update .all-contributorsrc [skip ci]</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/33629ece29594ec442cb363c9cb885dc36b8809a"><code>33629ec</code></a> docs: update README.md [skip ci]</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/1605bbcb2b4b458963167c12bb2c92fe4c272789"><code>1605bbc</code></a> Merge pull request <a href="https://redirect.github.com/mansenfranzen/autodoc_pydantic/issues/154">#154</a> from mansenfranzen/fix_pydantic_v2_incompatibility</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/1b61fed303d56f5b82b5bae9d53a1969a3446394"><code>1b61fed</code></a> Provide upper version boundary to exclude pydantic v2.</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/19ca2ba9d6a76f6338ce0c267761da11f5a63d3c"><code>19ca2ba</code></a> Merge pull request <a href="https://redirect.github.com/mansenfranzen/autodoc_pydantic/issues/151">#151</a> from mansenfranzen/fix_docs_codecov</li>
<li><a href="https://github.com/mansenfranzen/autodoc_pydantic/commit/af8a6f249a4784269e7c16951eb005e5ef5c9029"><code>af8a6f2</code></a> Test new pytest and coverage versions.</li>
<li>Additional commits viewable in <a href="https://github.com/mansenfranzen/autodoc_pydantic/compare/v1.8.0-a.1...v1.9.0">compare view</a></li>
</ul>
</details>
<br />
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Updates the requirements on autodoc-pydantic to permit the latest version.
Changelog
Sourced from autodoc-pydantic's changelog.