autodoc_pydantic

autodoc_pydantic copied to clipboard

Generate output with nonvalidation methods

2

For a class such as the following, the `print_something` non-validation method does not get generated into the documentation. I think I've checked thoroughly in the [configurationdocumentation](https://autodoc-pydantic.readthedocs.io/en/main-1.x/users/configuration.html) and can't see an...

daquinteroflex

Cannot use `inherited-members` directive with autosummary

2

I would like to exclude all members from pydantic.BaseModel (e.g. copy(), schema() etc…) as described here: https://autodoc-pydantic.readthedocs.io/en/stable/users/faq.html#show-inherited-fields-validators but using **autosummary** instead. Since it seems that the `inherited-members` directive is not...

alejandro-yousef

Does `autodoc-pydantic` support the `pydantic.v1` compatibility layer?

2

Hi, my team is trying to move our relatively large codebase over to pydantic v2 and were hoping to do this gradually using the [`pydantic.v1` compatibility layer](https://docs.pydantic.dev/latest/migration/#continue-using-pydantic-v1-features). Upon our testing,...

goroderickgo

Render field examples

2

pydantic has a [`examples` parameter](https://docs.pydantic.dev/latest/api/fields/#pydantic.fields.Field). However it seems to not be rendered by autodoc_pydantic and I could not find documentation about this. I suggest to render the field examples in...

azmeuk

@computed_field not showing in json schema

2

This is something I had also reported to [FastAPI](https://github.com/tiangolo/fastapi/discussions/9856) and it has been fixed. The issue is that pydantic now has [two serialization modes](https://docs.pydantic.dev/latest/api/json_schema/#pydantic.json_schema.JsonSchemaMode): `input` and `serialization`. Since a computed...

Galarzaa90

Allow `autodoc_pydantic_field_signature_prefix` to be empty

1

Hi. Currently `autodoc_pydantic_field_signature_prefix` cannot be `None` (else it raises an exception while documentation is built) or an empty string (else the default `attribute` value is used). I would love to...

azmeuk

Cannot generate documentation when having class with arbitrary types

1

Hello and thank you for this library, I have a class with arbitrary types such like: ```python from collections.abc import AsyncIterator class MyClass(BaseModel): stream: AsyncIterator[bytes] model_config = ConfigDict(arbitrary_types_allowed=True) ``` And...

tkaraouzene

Deprecation warning `sphinx.util.typing.stringify` for Sphinx v7.2.6

1

``` Running Sphinx v7.2.6 /home/huxuan/Code/serious-scaffold-python/.venv/lib/python3.10/site-packages/sphinxcontrib/autodoc_pydantic/directives/autodocumenters.py:21: RemovedInSphinx80Warning: The alias 'sphinx.util.typing.stringify' is deprecated, use 'sphinx.util.typing.stringify_annotation' instead. Check CHANGES for Sphinx API modifications. from sphinx.util.typing import get_type_hints, stringify ```

huxuan

Hello, I think this is a bug (not recursively resolved maybe?). I will give two code snippets for minimal reproducers and at the very bottom is the `rst` code and...

tasansal

Generating pydantic documentation with autosummary

3

Thank you for creating this library! I'm struggling a bit with the instructions to get "autodoc_pydantic" and "autosummary" to play nicely together. I was hoping you could clarify the instructions...

bdhammel