sphinxcontrib-prefectviz 0.2.0

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

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.

Installation

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

pip install sphinxcontrib-prefectviz

Configuration

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

extensions = [ 'sphinxcontrib.prefectviz' ]

Usage

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

.. flowviz:: module.submodule.flow

Long story

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

Links

• Source: https://github.com/sp1thas/sphinxcontrib-prefectviz

• Bugs: https://github.com/sp1thas/sphinxcontrib-prefectviz/issues