mkdocs.yml

site_name: AutomateDV
site_author: Datavault
site_dir: 'site'
repo_name: 'Datavault-UK/automate-dv'
site_url: 'https://automate-dv.readthedocs.io/'
repo_url: 'https://github.com/Datavault-UK/automate-dv'
dev_addr: 127.0.0.1:8001
edit_uri: ""

theme:
  name: 'material'
  custom_dir: 'overrides'
  show_sidebar: true
  logo: 'assets/images/logo.png'
  favicon: 'assets/images/favicon.ico'
  banner_dark: 'assets/images/banner/docs-banner-adv-drk.png'
  banner_light: 'assets/images/banner/docs-banner-adv-lgt.png'
  palette:
    - scheme: default
      primary: 'black'
      accent: 'indigo'
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: 'black'
      accent: 'indigo'
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  icon:
    annotation: material/arrow-right-circle-outline
  highlightjs: true
  features:
    - announce.dismiss
    - navigation.top
    - navigation.indexes
    - content.tabs.link

nav:
  - Home: 'index.md'
  - Tutorials:
      - Getting Started: 'tutorial/index.md'
      - Staging: 'tutorial/tut_staging.md'
      - Hubs: 'tutorial/tut_hubs.md'
      - Links: 'tutorial/tut_links.md'
      - Non-Historized Links: 'tutorial/tut_nh_links.md'
      - Satellites: 'tutorial/tut_satellites.md'
      - Effectivity Satellites: 'tutorial/tut_eff_satellites.md'
      - Multi-Active Satellites: 'tutorial/tut_multi_active_satellites.md'
      - Extended Tracking Satellites: 'tutorial/tut_xts.md'
      - As of Date Tables: 'tutorial/tut_as_of_date.md'
      - Point In Time (PIT) tables: 'tutorial/tut_point_in_time.md'
      - Bridge Tables: 'tutorial/tut_bridges.md'
      - Reference Tables: 'tutorial/tut_ref_tables.md'
  - Worked example:
      - Getting Started: 'worked_example/index.md'
      - Project setup: 'worked_example/we_setup.md'
      - Profiling TPC-H: 'worked_example/we_tpch_profile.md'
      - Creating the stage layers: 'worked_example/we_staging.md'
      - Loading the vault: 'worked_example/we_loading.md'
  - Metadata Reference: 'metadata.md'
  - Macros:
      - 'macros/index.md'
      - Stage Macro Configurations: 'macros/stage_macro_configurations.md'
  - Materialisations: 'materialisations.md'
  - Best Practices:
      - 'best_practises/index.md'
      - Hashing: 'best_practises/hashing.md'
      - Escaping: 'best_practises/escaping.md'
      - NULL Handling: 'best_practises/null_handling.md'
      - Loading: 'best_practises/loading.md'
      - Materialisations: 'best_practises/materialisations.md'
  - Migration Guides: 'migration_guides.md'
  - Extending: 'extending.md'
  - Roadmap: 'roadmap.md'
  - dbt Compatibility: 'versions.md'
  - Platform Support: 'platform_support.md'
  - Changelog:
      - Stable Releases: 'changelog/index.md'
      - Beta Releases: 'changelog/beta.md'
      - Archived Releases: 'changelog/archived.md'
  - Contributing:
    - 'contributing/index.md'
  - Licence: 'LICENSE.md'
  - Find Us:
      - GitHub: 'https://github.com/Datavault-UK/automate-dv'
      - Facebook: 'https://www.facebook.com/DataVaultUK/'
      - Twitter: 'https://twitter.com/datavault_uk'
      - LinkedIn: 'https://www.linkedin.com/company/business-thinking-limited'
      - Slack: 'https://join.slack.com/t/dbtvault/shared_invite/enQtODY5MTY3OTIyMzg2LWJlZDMyNzM4YzAzYjgzYTY0MTMzNTNjN2EyZDRjOTljYjY0NDYyYzEwMTlhODMzNGY3MmU2ODNhYWUxYmM2NjA'
      - Data Vault User Group: 'https://www.ukdatavaultusergroup.co.uk/'
      - Data Vault User Group Forums: 'https://forum.ukdatavaultusergroup.co.uk/'
      - YouTube: 'https://www.youtube.com/channel/UCdhSsZWTwkX1-v8EX84WLYg'
      - Datavault Website: 'https://www.data-vault.com/'
      - AutomateDV Website: 'https://www.automate-dv.com'

extra:
  social:
    - icon: 'fontawesome/solid/globe'
      link: 'https://www.automate-dv.com'
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/Datavault-UK/'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/Automate_DV'
    - icon: 'fontawesome/brands/linkedin'
      link: 'https://www.linkedin.com/showcase/dbtvault/'
    - icon: 'fontawesome/brands/facebook'
      link: 'https://www.facebook.com/DataVaultUK/'

markdown_extensions:
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - abbr
  - md_in_html
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.highlight:
      linenums: true
  - pymdownx.magiclink:
      repo_url_shorthand: true
      repo_url_shortener: true
  - toc:
      permalink: true
      toc_depth: 1-3
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list

plugins:
  - search
  - git-revision-date-localized:
      type: timeago
  - redirects:
      redirect_maps:
        'tutorial/tut_t_links.md': 'tutorial/tut_nh_links.md'

extra_css:
  - 'stylesheets/extra.css'
  - 'stylesheets/all.css'
  - 'stylesheets/icons.css'

copyright: AutomateDV (f.k.a dbtvault) and documentation © Business Thinking trading as Datavault 2019-2024 - Data Vault 2.0™ is a trademark of Empowered Holdings LLP - dbt is a registered trademark of dbt labs