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 files for sphinx-pandera 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_pandera-0.0.6.tar.gz | 13.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_pandera-0.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:27.2 kB
Release files / sphinx_pandera-0.0.6.tar.gz
| Download URL | sphinx_pandera-0.0.6.tar.gz |
|---|---|
| Size | 13.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
02b7e609b1c7e61cf26d8e7168d0148ad6c4659f0b4334388e1ee8190ed0aaf6
|
|
BLAKE2b-256 checksum How to use checksums |
ebda7af20c763fba58503aef521060c2512137436b00dce0425effb0f0b4276f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.11.13 Linux/6.6.87.2-microsoft-standard-WSL2
|
Release files / sphinx_pandera-0.0.6-py3-none-any.whl
| Download URL | sphinx_pandera-0.0.6-py3-none-any.whl |
|---|---|
| Size | 13.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
30f200f33be3a79228dbe5e0c43ae3874cff9dd15d645c4d76e8bb66b07b6a9d
|
|
BLAKE2b-256 checksum How to use checksums |
a62c4a2591c97ded786fd411ffedf0faceeb14a5bc89aa984093795f71831f36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.11.13 Linux/6.6.87.2-microsoft-standard-WSL2
|
