tabctx/mkdocs.yml at main · VectorInstitute/tabctx · 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
site_name: tabctx
site_description: The serving engine for tabular foundation models.
site_url: https://vectorinstitute.github.io/tabctx/
repo_url: https://github.com/VectorInstitute/tabctx
repo_name: VectorInstitute/tabctx
edit_uri: edit/main/docs/
copyright: Built at the <a href="https://vectorinstitute.ai">Vector Institute</a>. Apache 2.0.

theme:
  name: material
  logo: assets/icon.svg
  favicon: assets/icon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - toc.follow

extra_css:
  - stylesheets/extra.css

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

hooks:
  - docs/hooks.py

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: [".", "docs"]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            members_order: source
            merge_init_into_class: true
            filters: ["!^_"]
            heading_level: 3

exclude_docs: |
  hooks.py
  __pycache__/

nav:
  - Home: index.md
  - Get started:
      - Quickstart: getting-started/quickstart.md
      - Python and scikit-learn: getting-started/python.md
      - HTTP API: getting-started/http.md
  - Guides:
      - Serving: serving.md
      - Kubernetes: kubernetes.md
      - Coding agents: coding-agents.md
  - Concepts:
      - Why a server: why-tabctx.md
      - How it works: how-it-works.md
      - Benchmarks: benchmarks.md
  - Reference:
      - Python API: reference/python.md
      - HTTP API: reference/http-api.md
      - Configuration: reference/configuration.md
  - Contribute:
      - Contributing: contributing/index.md
      - Add a model: contributing/adding-a-model.md
      - Roadmap: roadmap.md
      - Changelog: changelog.md