SamayDocs/mkdocs.yml at main · AdityaLab/SamayDocs · 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
site_name: "Samay"
site_url: https://adityalab.github.io/Samay/
site_description: "A unified Python library for time-series foundational models"
site_author: "Harshavardhan Kamarthi & B. Aditya Prakash"
repo_url: https://github.com/AdityaLab/Samay
repo_name: AdityaLab/Samay

theme:
  name: material
  palette:
    primary: indigo
    accent: blue
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AdityaLab/Samay

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [Samay/src]
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true
            show_signature: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra_javascript:
  - javascripts/external-links.js
  - javascripts/header-link.js

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Models:
      - LPTM: models/lptm.md
      - MOMENT: models/moment.md
      - TimesFM: models/timesfm.md
      - Chronos: models/chronos.md
      - MOIRAI: models/moirai.md
      - TinyTimeMixer: models/ttm.md
  - API Reference:
      - Models: api/models.md
      - Datasets: api/datasets.md
      - Metrics: api/metrics.md
  - Examples: examples.md