Use pydantic documentation plugin.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 2
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Pydantic model class does not render as expected in the docs page.
But pydantic has documentation plugins that can show schemas as well, so we should use it.
Contributor guide
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 by locating the documentation configuration and the docs page where the Pydantic model currently renders incorrectly. Review the available Pydantic documentation plugin options, then configure the appropriate one so the model schema is displayed as intended and verify the rendered documentation page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100