FastFlowTransform/mkdocs.yml at main · FFTLabs/FastFlowTransform · 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
site_name: "FastFlowTransform – SQL & Python data transformation framework"
site_description: "Open-source Python framework for SQL & Python data modeling, ETL pipelines, and data quality tests on DuckDB, Postgres, BigQuery, Databricks and Snowflake."
site_url: https://MirrorsAndMisdirections.github.io/FastFlowTransform/
repo_url: https://github.com/MirrorsAndMisdirections/FastFlowTransform
repo_name: MirrorsAndMisdirections/FastFlowTransform

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Quickstart: Quickstart.md
  - Technical Overview: Technical_Overview.md
  - API & Models: Api_Models.md
  - Configuration & Macros: Config_and_Macros.md
  - Contracts: Contracts.md
  - Cache & Parallelism: Cache_and_Parallelism.md
  - Incremental Processing: Incremental.md
  - Profiles & Environments: Profiles.md
  - Sources Declaration: Sources.md
  - Project Configuration: Project_Config.md
  - State Selection: State_Selection.md
  - YAML Tests: YAML_Tests.md
  - Data Quality Tests: Data_Quality_Tests.md
  - Source Freshness: Source_Freshness.md
  - CLI Guide: CLI_Guide.md
  - Auto Docs: Auto_Docs.md
  - Logging: Logging.md
  - Unit Tests: Unit_Tests.md
  - Snapshots: Snapshots.md
  - CI Checks & Change-Aware Runs: CI_Check.md
  - Cost Monitoring: Cost_Monitoring.md
  - Hooks: Hooks.md
  - Packages: Packages.md
  - Troubleshooting: Troubleshooting.md
  - Examples:
      - Basic Demo: examples/Basic_Demo.md
      - Materializations Demo: examples/Materializations_Demo.md
      - Environment Matrix: examples/Environment_Matrix.md
      - Data Quality Tests Demo: examples/DQ_Demo.md
      - Macros Demo: examples/Macros_Demo.md
      - Cache Demo: examples/Cache_Demo.md
      - Incremental Demo: examples/Incremental_Demo.md
      - API Demo: examples/API_Demo.md
      - Local Engine Setup: examples/Local_Engine_Setup.md
      - Snapshot Demo: examples/Snapshot_Demo.md
      - Hooks Demo: examples/Hooks_Demo.md
      - Packages Demo: examples/Packages_Demo.md
  - API Reference: reference/
  - Contributing: Contributing.md
  - License: License.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - .
        - docs
      check_paths: true
  - pymdownx.magiclink

plugins:
  - search
  - autorefs
  - gen-files:
      scripts:
        - docs/_scripts/gen_api.py
  - literate-nav
  - mkdocstrings:
      handlers:
        python:
          paths: ["src"]
          options:
            docstring_style: google
            show_source: true
            separate_signature: true
            members_order: source
            inherited_members: true
            show_bases: true
            show_if_no_docstring: false
            filters: ["!^_"]
  - section-index


extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/MirrorsAndMisdirections