blueno/mkdocs.yml at main · mrjsj/blueno · 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
site_name: blueno
site_description: blueno, a platform agnostic Python library for writing declarative data pipelines
site_url: https://mrjsj.github.io/blueno
repo_url: https://github.com/mrjsj/blueno
repo_name: mrjsj/blueno

theme:
  name: material
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/lightbulb-auto
      name: Switch to light mode
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: teal
    accent: deep orange
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: teal
    accent: deep orange
    toggle:
      icon: material/lightbulb-outline
      name: Switch to system preference
  # navigation_depth: 3
  features:
    - content.code.annotation
    - content.code.copy
    - content.tabs.link
    - content.footnote.tooltips

    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress

    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky

    - navigation.top
    - navigation.tracking

    - search.highlight
    - search.share
    - search.suggest

    - toc.follow

  icon:
    repo: fontawesome/brands/github-alt
  logo: assets/images/blueno-128x128.png
  favicon: assets/images/blueno-128x128.png
  language: en

plugins:
  - search:
      lang: en
  - include_dir_to_nav
  # - gen-files:
  #     scripts:
  #       - docs/gen_ref_pages.py
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_root_toc_entry: false
            docstring_style: google
            show_source: false
            show_root_heading: false
            filters: ["!^_", "^__init__$"]
            show_object_full_path: false
            # heading_level: 2
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            docstring_section_style: table
            show_if_no_docstring: false

nav:
  - Blueno:
    - index.md
  - Features:
    - features/index.md
  - Learn:
    - learn/quick-start.md
    # - ETL:
    #   - learn/etl/extract.md
    #   - learn/etl/transform.md
    #   - learn/etl/load.md
    - Blueprints:
      - learn/blueprints/introduction.md
      - learn/blueprints/tasks.md
      - learn/blueprints/custom_jobs.md
    - learn/examples.md
    # - Microsoft Fabric:
    #   - learn/microsoft-fabric/index.md
  - API Reference:
      - api/blueprint.md
      - api/etl.md
      - api/utils.md
      - api/exceptions.md


  # - API Reference:
  #     - Orchestration:
  #       - reference/orchestration/index.md
  #       - reference/orchestration/blueprint.md
  #       - reference/orchestration/task.md
  #     - ETL:
  #       - reference/etl/index.md
  #       - reference/etl/read.md
  #       - reference/etl/transform.md
  #       - reference/etl/load.md
  #     - reference/authentication.md
  #     - reference/utilities.md
  #     - reference/cli.md

# Formatting options
markdown_extensions:
  # Python Markdown
  abbr:
  attr_list:
  footnotes:
  md_in_html:
  tables:
  toc:

    permalink: true

  # Python Markdown Extensions
  pymdownx.betterem:
    smart_enable: all
  pymdownx.caret:
  pymdownx.highlight:
    line_spans: __span

  pymdownx.inlinehilite:
  pymdownx.keys:
  pymdownx.mark:
  pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format

  # pymdownx blocks
  pymdownx.tilde:
  pymdownx.blocks.admonition:
    types:
      - note
      - attention
      - caution
      - danger
      - error
      - tip
      - hint
      - warning
      - info

  pymdownx.blocks.details:
  pymdownx.blocks.tab:
    alternate_style: true

  mdx_include:
  markdown_include_variants:

extra_javascript:
  - js/termynal.js
  - js/custom.js

extra_css:
  - css/termynal.css
  - css/custom.css

  # - admonition
  # - pymdownx.details
  # - attr_list
  # - tables
  # - pymdownx.tabbed:
  #     alternate_style: true
  # - pymdownx.snippets:
  #     base_path: ['.','docs/source/src/']
  #     check_paths: true
  #     dedent_subsections: true
  # - footnotes
  # - pymdownx.arithmatex:
  #     generic: true