vectrix/mkdocs.yml at master · eddmpython/vectrix · 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
118
119
120
121
122
123
site_name: Vectrix
site_url: https://eddmpython.github.io/vectrix/docs/
site_description: "Zero-config time series forecasting for Python. 30+ models, auto selection, flat defense, Forecast DNA — one line of code."
site_author: eddmpython
repo_url: https://github.com/eddmpython/vectrix
repo_name: eddmpython/vectrix

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github
    logo: material/chart-timeline-variant-shimmer
  favicon: stylesheets/favicon.svg
  font:
    text: Inter
    code: JetBrains Mono

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/eddmpython/vectrix
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/vectrix/
  generator: false

extra_css:
  - stylesheets/theme.css

exclude_docs: |
  **/*.ko.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: numpy
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quickstart: getting-started/quickstart.md
  - Tutorials:
    - tutorials/index.md
    - Quickstart: tutorials/01_quickstart.md
    - Analysis & DNA: tutorials/02_analyze.md
    - Regression: tutorials/03_regression.md
    - 30+ Models: tutorials/04_models.md
    - Adaptive Intelligence: tutorials/05_adaptive.md
    - Business Intelligence: tutorials/06_business.md
    - Visualization: tutorials/07_visualization.md
  - User Guide:
    - Forecasting: guide/forecasting.md
    - Analysis & DNA: guide/analysis.md
    - Regression: guide/regression.md
    - Adaptive Intelligence: guide/adaptive.md
    - Business Intelligence: guide/business.md
    - Pipeline: guide/pipeline.md
    - Foundation Models: guide/foundation.md
    - Multivariate: guide/multivariate.md
  - API Reference:
    - Easy API: api/easy.md
    - Vectrix Class: api/vectrix.md
    - Adaptive: api/adaptive.md
    - Business: api/business.md
    - Regression: api/regression.md
    - Pipeline: api/pipeline.md
    - Foundation & Neural: api/foundation.md
    - Multivariate & Distributions: api/multivariate.md
    - Types: api/types.md
  - Benchmarks: benchmarks.md
  - Changelog: changelog.md

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