autodoc_pydantic | Seamlessly integrate pydantic models in your Sphinx | REST library

by mansenfranzen Python Version: 2.2.0 License: MIT

X-Ray Key Features Code Snippets Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | autodoc_pydantic Summary

autodoc_pydantic is a Python library typically used in Web Services, REST, Swagger applications. autodoc_pydantic has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. However autodoc_pydantic build file is not available. You can install using 'pip install autodoc_pydantic' or download it from GitHub, PyPI.

You love pydantic and you want to document your models and configuration settings with sphinx?. Perfect, let's go. But wait, sphinx' autodoc does not integrate too well with pydantic models . Don't worry - just pip install autodoc_pydantic .

Support

Quality

Security

License

Reuse

Support

autodoc_pydantic has a low active ecosystem.

It has 86 star(s) with 10 fork(s). There are 3 watchers for this library.

There were 2 major release(s) in the last 6 months.

There are 12 open issues and 43 have been closed. On average issues are closed in 17 days. There are 1 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of autodoc_pydantic is 2.2.0

Quality

autodoc_pydantic has 0 bugs and 81 code smells.

Security

autodoc_pydantic has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

autodoc_pydantic code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

autodoc_pydantic is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

autodoc_pydantic releases are not available. You will need to build from source code and install.

Deployable package is available in PyPI.

autodoc_pydantic has no build file. You will be need to create the build yourself to build the component from source.

It has 6136 lines of code, 352 functions and 66 files.

It has low code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed autodoc_pydantic and discovered the below as its top functions. This is intended to give you an instant insight into autodoc_pydantic implemented functionality, and help decide if they suit your requirements.

Add additional information
Convert JSON schema to REST format
Return the value of the named option
Add collable schema
Create nodes
Return a string representing the configuration values
Process the enable option
Returns a mapping of validator to validator
Return a dictionary of attributes
Show the version information
Return a sanitized representation of the model
Add extra_content fields
Setup Sphinx extension
Creates a function that returns an option that is one of the given choices
Determines if a field needs an optional default
Replace the signature from the signature
Create documentation links
Overrides document members
Create a set of validator field names
Add extra content
Decorator to add to the directive header
Overrides doc_members
Create a ModelInspector from a child signode
Add signature and prefix
Get the signature prefix
Run Sphinx

Get all kandi verified functions for this library.

autodoc_pydantic Key Features

No Key Features are available at this moment for autodoc_pydantic.

autodoc_pydantic Examples and Code Snippets

No Code Snippets are available at this moment for autodoc_pydantic.

Community Discussions

Trending Discussions on autodoc_pydantic

autodoc_pydantic: Show fields from parent model

QUESTION

autodoc_pydantic: Show fields from parent model

Asked 2022-Apr-02 at 00:16

I'm using the autodoc_pydantic plugin for Sphinx to document my pydantic.BaseModel classes. However, there are cases where I have something like

...

ANSWER

Answered 2022-Apr-02 at 00:16

It can be accomplished via the :inherited-members: option:

Source https://stackoverflow.com/questions/71709960

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install autodoc_pydantic

You can install using 'pip install autodoc_pydantic' or download it from GitHub, PyPI.
You can use autodoc_pydantic like any standard Python library. You will need to make sure that you have a development environment consisting of a Python distribution including header files, a compiler, pip, and git installed. Make sure that your pip, setuptools, and wheel are up to date. When using pip it is generally recommended to install packages in a virtual environment to avoid changes to the system.