This release is a pre-release and may not be stable for production use.
sphinxcontrib-prefectviz
A Sphinx extension to add Prefect flow visualizations.
Overview
This Sphinx extension allows you to add your prefect flow visualization into your Sphinx documentation using a single directive.
Installation
The best way to install this extension is to install it via PyPi:
pip install sphinxcontrib-prefectvizConfiguration
Add 'sphinxcontrib.prefectviz' to the extensions list in conf.py.
extensions = [ 'sphinxcontrib.prefectviz' ]Usage
Long story short:
.. flowviz:: module.submodule.flowAn example:
First of all, you have to make sure that your prefect flow(s) can be imported by your Sphinx project. Let’s start with the following example, our prefect flow is in the same directory with the Sphinx project:
docs
├── _build
├── conf.py
├── index.rst
├── make.bat
├── Makefile
├── _static
├── _templates
└── flow.pyand the flow.py looks like:
from prefect import task, Flow
@tast
def hello_world():
print("Hello world")
with Flow(name="foo") as f:
hello_world()Links
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-prefectviz 0.1.1.dev1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-prefectviz-0.1.1.dev1.tar.gz | 5.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_prefectviz-0.1.1.dev1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.3 kB
Release files / sphinxcontrib-prefectviz-0.1.1.dev1.tar.gz
| Download URL | sphinxcontrib-prefectviz-0.1.1.dev1.tar.gz |
|---|---|
| Size | 5.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
df6d90f1305a485871084d57180879761932e1a742b3e838ac7565947e49c4b4
|
|
BLAKE2b-256 checksum How to use checksums |
1b45d8455729ba453b01e5ccf4519c574ff8821d4bb572c503f795eb6a14d8d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Release files / sphinxcontrib_prefectviz-0.1.1.dev1-py3-none-any.whl
| Download URL | sphinxcontrib_prefectviz-0.1.1.dev1-py3-none-any.whl |
|---|---|
| Size | 5.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fb29f40c0a791c02525bc78e89f14a2595dc72630c8a511cb00f2c6e0babc327
|
|
BLAKE2b-256 checksum How to use checksums |
cc5883cd71cc90df96d8faa772d7c1f624324bde9f5bd92fc093445b87e29eb7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
