ravnar/mkdocs.yml at main · nebari-dev/ravnar · 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
site_name: ravnar

watch:
  - src
  - scripts/docs

theme:
  name: material
  features:
    - content.tabs.link
    - content.code.copy
    - search.suggest

plugins:
  - search
  - macros:
      module_name: scripts/docs/macros
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_bases: false
            unwrap_annotated: true
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://pydantic.dev/docs/validation/objects.inv
            - https://pydantic.dev/docs/ai/objects.inv
  - gen-files:
      scripts:
        - scripts/docs/gen_files.py
  - mkdocs-jupyter:
      execute: true
      include_source: True

hooks:
  - scripts/docs/hooks.py

extra:
  analytics:
    provider: google
    property: G-NXNMX83GGS
  consent:
    title: Cookie consent
    description: >-
      We use cookies to analyze site traffic and improve your experience. With your consent, you help us make our
      documentation better.
    actions:
      - accept
      - reject
      - manage
    cookies:
      analytics:
        name: Google Analytics
        checked: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - codehilite
  - mdx_truly_sane_lists

nav:
  - index.md
  - Architecture: architecture.md
  - Deployment: deploy.md
  - Tutorials:
      - Authentication: tutorials/authentication.py
      - Configuring an agent: tutorials/agents.py
  - References:
      - Configuration: references/config.md
      - Python API: references/python_api.md
      - REST API: references/rest_api.md
      - CLI: references/cli.md
      - Helm chart: references/helm-chart.md