fev/mkdocs.yml at main · S-FM/fev · 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
site_name: fev
site_description: A lightweight library for benchmarking time series forecasting models
site_url: https://autogluon.github.io/fev/
repo_url: https://github.com/autogluon/fev
repo_name: autogluon/fev

theme:
  name: material
  palette:
    primary: blue

extra:
  version:
    provider: mike

plugins:
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_category_heading: true
            group_by_category: true


nav:
  - Home: index.md
  - Tutorials:
    - Quickstart: tutorials/01-quickstart.ipynb
    - Dataset Format: tutorials/02-dataset-format.ipynb
    - Tasks & Benchmarks: tutorials/03-tasks-and-benchmarks.ipynb
    - Adapters: tutorials/04-adapters.ipynb
    - Models: tutorials/05-add-your-model.ipynb
  - API Reference:
    - Task: api/task.md
    - EvaluationWindow: api/evaluation-window.md
    - Benchmark: api/benchmark.md
    - Analysis methods: api/analysis.md
    - Utility methods: api/utilities.md
    - Metrics: api/metrics.md

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - attr_list
  - md_in_html