nextpipe/mkdocs.yml at develop · nextmv-io/nextpipe · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
site_name: Nextpipe
site_description: Documentation for Nextpipe, a Python library for Decision Workflows
repo_url: https://github.com/nextmv-io/nextpipe
repo_name: nextmv-io/nextpipe
site_author: Nextmv

nav:
  - Home:
      - Overview & installation: index.md
      - Tutorials:
          - Orchestrate multiple models: tutorials/orchestrate-multiple-models.md
      - Examples:
          - Basic chained workflow: examples/basic-chained-workflow.md
          - Multi-file workflow: examples/multifile-workflow.md
          - Fanout workflow: examples/fanout-workflow.md
          - Ensemble workflow: examples/ensemble-workflow.md
          - Complex workflow: examples/complex-workflow.md
          - Complex workflow with CSV: examples/complex-workflow-csv.md
      - Reference:
          - The echo app: reference/echo.md
          - The echo-multi app: reference/echo-multi.md
          - config.py: reference/config.md
          - decorators.py: reference/decorators.md
          - flow.py: reference/flow.md
          - graph.py: reference/graph.md
          - schema.py: reference/schema.md
          - threads.py: reference/threads.md
          - uplink.py: reference/uplink.md
          - utils.py: reference/utils.md
theme:
  name: material
  logo: images/logo-180.png
  favicon: images/nextmv-favicon.svg
  font:
    text: L10-Web
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.collapse
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.share
    - toc.follow
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: cyan
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: cyan
      accent: indigo
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to system preference

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            backlinks: tree
            show_source: true
            heading_level: 2
            parameter_headings: true
            show_root_heading: true
            show_root_toc_entry: false
            show_root_full_path: false
            show_root_members_full_path: false
            show_object_full_path: false
            group_by_category: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            inherited_members: true
            members_order: alphabetical
            show_submodules: true
            show_labels: true
            docstring_style: numpy
            docstring_section_style: spacy
            docstring_options:
              ignore_init_summary: false
            merge_init_into_class: true
            relative_crossrefs: true
            show_if_no_docstring: true
            show_docstring_attributes: true
            show_docstring_functions: true
            show_docstring_classes: true
            show_docstring_modules: true
            show_docstring_description: true
            show_docstring_examples: true
            show_docstring_other_parameters: true
            show_docstring_parameters: true
            show_docstring_raises: true
            show_docstring_receives: true
            show_docstring_returns: true
            show_docstring_warns: true
            show_docstring_yields: true
            show_signature: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            filters:
              - "!^_"

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 4
  - attr_list
  - def_list
  - tables
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  generator: false