Sphinx Pandera
Project description
Sphinx extension for Pandera models
Description
This packages bridges pandera models with sphinx to generate documentation for your pandera models. It is based on a similar project for pydantic autodoc_pydantic.
Our vision is to have one place where you :
- describe
- validate
- document your data
Pandera already does step 1 and 2. Sphinx-pandera fills the documentation gap. This way, your pandera model is the single source of truth for your data.
Useful links
-
Documentation: https://has-sante.pages.has-sante.fr/public/alpha/sphinx-pandera
-
Example: https://has-sante.pages.has-sante.fr/public/alpha/sphinx-pandera/examples/basic.html
-
Source code: https://gitlab.has-sante.fr/has-sante/public/alpha/sphinx-pandera
State of the project
This project is in alpha state, we welcome feature requests and contributions.
There might be some delays when answering issues and merge requests.
It has been initiated by the Mission data at the French National Authority for Health.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_pandera-0.0.3.tar.gz.
File metadata
- Download URL: sphinx_pandera-0.0.3.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.8.16 Linux/5.15.153.1-microsoft-standard-WSL2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f08fac6fe3f0e0f020b5c5f39aa1d5066655cca7446d82d6ca11475bd7b73694
|
|
| MD5 |
6fd1523fa4cddc395952573743ebf792
|
|
| BLAKE2b-256 |
b8ef5f7a2afad389c0d7a196ab6802bb08f6311b5f4c117b01f22b9edcd9a7c1
|
File details
Details for the file sphinx_pandera-0.0.3-py3-none-any.whl.
File metadata
- Download URL: sphinx_pandera-0.0.3-py3-none-any.whl
- Upload date:
- Size: 13.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.8.16 Linux/5.15.153.1-microsoft-standard-WSL2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b710aadad5402028c6eb7d1e2efc7b78e6f9ba495dacd3e5929f50a039f186a1
|
|
| MD5 |
e8460f6403cc217a107dbc15e98e4d41
|
|
| BLAKE2b-256 |
0f694e06a02b4782f1c4f592746222183cb70186c585bda2a612e98e28b4917a
|
