sphinxcontrib-prefectviz

An extension to add Prefect flow visualizations into you Sphinx documentation.

Overview

This Sphinx extension allows you to add your prefect flow visualization into your Sphinx documentation using a single directive.

The best way to install this extension is to install it via PyPi:

pip install sphinxcontrib-prefectviz

Add 'sphinxcontrib.prefectviz' to the extensions list in conf.py.

extensions = [ 'sphinxcontrib.prefectviz' ]

Use the following directive to add a flow visualization into your documentation.

.. flowviz:: module.submodule.flow

First of all, make sure that your prefect flow(s) can be imported by your Sphinx project.

In our case, we have to comment-in the following LOC in the top of conf.py:

import os
import sys
sys.path.insert(0, os.path.abspath('.'))

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.py

and the flow.py looks like:

from prefect import task, Flow

@task
def hello_world():
    print("Hello world")

with Flow(name="foo") as flow:
    hello_world()

Finally, add the flow visualization using the following directive:

.. flowviz:: flow.flow

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for sphinxcontrib-prefectviz 0.2.0
File	Size	Uploaded
sphinxcontrib-prefectviz-0.2.0.tar.gz	5.7 kB	Oct 16, 2021	Details

Table of built distributions (wheels) for sphinxcontrib-prefectviz 0.2.0
File	Interpreter	ABI	Platform	Reset
sphinxcontrib_prefectviz-0.2.0-py3-none-any.whl 6.0 kB Oct 16, 2021	Python 3	none	any	Details

Total release size: 11.7 kB

Download URL	sphinxcontrib-prefectviz-0.2.0.tar.gz
Size	5.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`008179c6105ed587fbe3716637c2c39071793b1dcfd7a5f84760039b0a970e58`
BLAKE2b-256 checksum How to use checksums	`fc856e007f2e42f2b0146fdd1533660c85d1c07649609b991d88041e0462f3c2`
Upload date	Oct 16, 2021
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`

Download URL	sphinxcontrib_prefectviz-0.2.0-py3-none-any.whl
Size	6.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a8388bf24bb0f6d185f183024071f0e3ce677ff1e7fa03a09da92540f422cd7f`
BLAKE2b-256 checksum How to use checksums	`cd28169d45aae4e99372c63221fecc0375a9741122d3fcc1d831aca83ba9b353`
Upload date	Oct 16, 2021
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`