viadot/mkdocs.yml at main · dyvenia/viadot · 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
site_name: viadot
site_url: https://github.com/dyvenia/viadot
repo_url: https://github.com/dyvenia/viadot
edit_uri: blob/main/docs/

nav:
  - Home: index.md

  - Getting Started:
      - Getting Started: getting_started.md

  - Developer Guide:
      - Introduction: developer_guide/index.md
      - Creating a source: developer_guide/creating_a_source.md
      - Creating a Prefect flow: developer_guide/creating_a_prefect_flow.md
      - Contributing: developer_guide/contributing_to_viadot.md

  - Advanced Usage:
      - Introduction: advanced_usage/index.md
      - Containerized development environment: advanced_usage/containerized_env.md

  - References:
      - Sources:
          - Database: references/sources/database.md
          - API: references/sources/api.md
          - Other: references/sources/other.md
      - Orchestration:
          - Prefect:
              - Tasks: references/orchestration/prefect/tasks.md
              - Flows: references/orchestration/prefect/flows.md

theme:
  name: "material"
  palette:
    - scheme: default
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Open Sans
    code: Fira Code
  logo: _static/logo.png
  favicon: _static/logo.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.code.copy
    - navigation.tracking
    - toc.follow
    - toc.integrate
    - content.action.view
    - content.action.edit
    - announce.dismiss
    - content.tooltips
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
  custom_dir: docs/overrides

plugins:
  - search
  - include_dir_to_nav
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: yes
            docstring_style: google
  - mike
  - neoteroi.mkdocsoad:
      use_pymdownx: true
  - mkdocs-jupyter
  - table-reader
  - include-markdown:
      cache: 600
  - social
  - git-revision-date
  - glightbox

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

markdown_extensions:
  - pymdownx.highlight:
      linenums: true
  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.keys
  - pymdownx.tilde
  - pymdownx.blocks.tab:
      alternate_style: True
  - admonition
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - abbr
  - pymdownx.snippets
  - def_list
  - footnotes
  - tables
  - attr_list
  - md_in_html

copyright: Copyright &copy; 2025 <a href="https://dyvenia.com/">dyvenia</a>

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dyvenia/viadot
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/dyvenia
    - icon: fontawesome/regular/envelope
      link: mailto:hello@dyvenia.com
      name: hello@dyvenia.com