docs/mkdocs.yml at main · anaglebushka/docs · 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
site_name: Datu AI Analyst
site_description: Datu AI Analyst is a Python SDK for building AI agents that can interact with data, perform analysis, and generate insights. It provides a framework for creating agents that can work with various data sources and tools, enabling developers to build intelligent applications that leverage AI capabilities.
site_url: https://docs.datu.fi/
site_author: "Datuanalytics"
site_dir: site

repo_url: https://github.com/Datuanalytics/datu-core

theme:
  name: material
  logo: assets/datusignature.png
  favicon: assets/favicon.ico
  features:
    - content.code.copy
    - content.code.select
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
  language: en
  custom_dir: docs/stylesheets
  icon:
    repo: fontawesome/brands/github
markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.highlight
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.emoji
  - tables
  - pymdownx.superfences:
      custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - User Guide:
    - Welcome: user-guide/README.md
    - Quickstart: user-guide/quickstart.md
    - Datasources:
        - user-guide/datasources/datasources.md
        - Postgres: user-guide/datasources/postgres.md
        - Sqlserver: user-guide/datasources/sqlserver.md
    - Configurations:
        - user-guide/configurations.md
    - Deploy:
      - Container service: user-guide/deploy/deploy_as_container_service.md
    - MCP:
        - user-guide/mcp/mcp_connectivity.md
    - Telemetry:
        - user-guide/telemetry/product.md
  - Architecture:
    - Overview: architecture/README.md
  - Contribute ❤️: https://github.com/Datuanalytics/datu-core/blob/main/CONTRIBUTING.md

exclude_docs: |
  node_modules
  .venv
  _dependencies

plugins:
  - search
  - privacy
  - macros
  - mike:
      alias_type: symlink
      canonical_version: latest
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_root_heading: true
            show_source: true
  - llmstxt:
      sections:
        User Guide:
          - README.md
          - user-guide/**/*.md

extra:
  social:
    - icon: fontawesome/brands/github
  version:
    provider: mike
  # Variables
  docs_repo: https://github.com/Datuanalytics/docs/tree/main
  server_pypi: https://pypi.org/project/datu-core/
  server_repo: https://github.com/Datuanalytics/datu-core/blob/main
  server_repo_home: https://github.com/Datuanalytics/datu-core

  # Custom header button (Book a Demo)
  header:
    - type: html
      html: '<a href="mailto:info@datu.fi" class="datu-demo-btn">Book a Demo</a>'

validation:
  nav:
    omitted_files: info
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn