evalio/mkdocs.yml at main · contagon/evalio · 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
124
125
126
127
128
129
130
131
132
133
134
135
site_name: evalio
site_url: http://contagon.github.io/evalio
repo_url: https://github.com/contagon/evalio
repo_name: contagon/evalio

extra:
  version:
    provider: mike

theme:
  name: material
  features:
    - navigation.instant # Instant loading of pages
    - navigation.sections # split nav bar into sections
    - navigation.top # button to go to top of the page
    # - navigation.indexes
    # - navigation.tabs
    - content.code.copy # add code copy button
    - content.tabs.link # make tabs sync
  icon:
    logo: material/circle-double
    favicon: material/circle-double # TODO: Not sure if this works
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: black
      toggle:
          icon: material/brightness-7
          name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

watch:
  - python/
  - cpp/

nav:
  - evalio:
    - About: index.md
    - Quickstart: quickstart.md
    - Source Build: install.md
  - Examples:
    - Odometry: examples/odometry.md
    - Data Loading: examples/data_loading.md
    - Evaluation: examples/evaluation.md
    - Custom Dataset: examples/dataset.md
    - Custom Pipeline: examples/pipeline.md
  - Included:
    - Datasets: included/datasets.md
    - Pipelines: included/pipelines.md
  - Reference:
    - cli: ref/cli.md
    - evalio.datasets: ref/datasets.md
    - evalio.pipelines: ref/pipelines.md
    - evalio.stats: ref/stats.md
    - evalio.types: ref/types.md
    - evalio.rerun: ref/rerun.md

plugins:
  # Add top level search
  search:
    lang: en

  # autogenerate evalio ls & cli pages
  gen-files:
    scripts:
      - docs/included.py
      - docs/ref/cli.py

  # Autogenerate docs from docstrings
  mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          show_source: true # don't show source code
          separate_signature: true # show the signature in a separate section
          show_signature_annotations: true # include types
          signature_crossrefs: true # show cross-references in the signature
          unwrap_annotated: true # remove Annotated[] from the signature
          show_symbol_type_toc: true # include printed symbol inline with meth/class/etc
          show_symbol_type_heading: true # include printed symbol in toc with meth/class/etc

          docstring_section_style: list # show parameters/args in a list
          # show_labels: false
          # show_category_heading: true
          docstring_style: google
          summary:
            attributes: true
            functions: true
            classes: true
            modules: false

markdown_extensions:
  # misc
  - tables
  - admonition

  # math
  - pymdownx.arithmatex:
      generic: true

  # syntax highlighting
  # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
  - pymdownx.details:
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  # auto sorting tables
  # https://squidfunk.github.io/mkdocs-material/reference/data-tables/#sortable-tables-docsjavascriptstablesortjs
  - javascripts/tablesort.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  # latex
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - css/tweaks.css