autodoc_pydantic
autodoc_pydantic copied to clipboard
mansenfranzen
Seamlessly integrate pydantic models in your Sphinx documentation.
I notice that this extension doesn't work with reused validators, i.e. [Pydantic's Reuse validators](https://pydantic-docs.helpmanual.io/usage/validators/#reuse-validators) section ``` from pydantic import BaseModel, validator def normalize(name: str) -> str: """Normalize docstring.""" return '...
I am using `pydantic.dataclasses.dataclass` because I need the `__post_init__` dunder. However, I noticed that automodule does not generate the pydantic model documentation for these data classes. Looking at pydantic's docs,...
``` invalid signature for autopydantic_model ('saf.collect.beacons::PipelineRunContext[BeaconsConfig]') make: *** [Makefile:20: coverage] Error 2 ``` ```python class BeaconsConfig(CollectConfigBase): """ Configuration schema for the beacons collect plugin. """ beacons: List[str] async def collect(*,...
In the last few releases, autodoc has added two settings to `conf.py` that are very useful: - `autodoc_preserve_defaults`: Preserves default argument values as they are in code, rather than evaluating...
Hi! Thanks for this package, I love the results it produces! I've been experimenting with ways to fully automate the generation of API reference documentation from source code and docstrings,...
Hi, I have encountered a simmilar issue as discussed in #78. My Pydantic models have fields with type of other Pydantic models, and when using `autodoc_pydantic_model_summary_list_order = 'bysource'` I still...
Hello, I think I have a proposed fix for #137. However, I am having problems running the tox tests due to problems with erdantic. I have tried ``` poetry run...
Hi, really love your extension and it makes `pydantic` so much more useful. :) Thank you for your work on this. I was wondering if you had considered adding an...
See screenshot. This is not supposed to happen, right?
Metadata
Owner
Metadata
Seamlessly integrate pydantic models in your Sphinx documentation.