readthedocs / readthedocs/sphinx-autoapi
Adding better support for pydantic models
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
I'd like to know if there is any way on how one can get better outputs for pydantic models.
There is a library called autodoc_pydantic, which provides better support for pydantic models. However as of now you are only using auto-doc:
Is there any chance that these implementations can be extended to be using the autodoc_pydantic ones for pydantic models?
What would be required to get this to work?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with autoapi/documenters.py at the linked reference and compare its current autodoc integration with the autodoc_pydantic project linked in the issue. Determine what support for Pydantic models would require; the issue does not define specific files, tests, or acceptance criteria for deciding when the work is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100