Skip to content

mdop

mdop

Module for generating markdown strings for dagster ops

Functions

get_md_op 

get_md_op(op_def)

generates markdown strings for dagster ops

Source code in niceml/mkdocs/mdop.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
def get_md_op(op_def: OpDefinition) -> str:
    """generates markdown strings for dagster ops"""
    col_widths: List[int] = [80, 120]
    op_fields = get_op_fields(op_def)
    headings: List[str] = ["ConfigKey", "Description"]
    cur_md: str = f"### Op: `{op_def.name}`\n\n"
    if op_def.description is not None:
        cur_md += op_def.description + "\n\n"
    contents: List[List[str]] = []
    for config_key in sorted(op_fields):
        desc = op_fields[config_key].description or ""
        contents.append([f"`{config_key}`", desc.replace("\n", " ")])
    cur_md += get_md_table(headings, col_widths, contents)
    cur_md += "\n\n"
    return cur_md

get_op_fields 

get_op_fields(op_def)

returns fields from OpDefinition

Source code in niceml/mkdocs/mdop.py 
25
26
27
28
29
30
def get_op_fields(op_def: OpDefinition) -> Dict[str, Field]:
    """returns fields from OpDefinition"""
    try:
        return op_def.config_schema.config_type.fields
    except AttributeError:
        return dict()