fuzzy-infer/mkdocs.yml at master · queelius/fuzzy-infer · 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
136
137
138
139
140
site_name: FuzzyInfer
site_description: Unix-compliant fuzzy logic inference with a beautiful fluent API
site_author: FuzzyInfer Contributors
site_url: https://fuzzy-infer.readthedocs.io/
repo_url: https://github.com/queelius/fuzzy-infer
repo_name: fuzzy-infer
edit_uri: edit/master/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  font:
    text: Inter
    code: JetBrains Mono

nav:
  - Home:
    - Introduction: index.md
    - Quick Start: quick-start.md
    - Installation: installation.md
  - User Guide:
    - Core Concepts: guide/concepts.md
    - Inference Engine: guide/inference.md
    - Fluent API: guide/fluent-api.md
    - CLI Usage: guide/cli.md
    - Unix Pipes: guide/unix-pipes.md
  - Examples:
    - Overview: guide/examples.md
    - Interactive Tutorial: guide/notebook.ipynb
  - API Reference:
    - Core Module: api/core.md
    - Models: api/models.md
    - Fluent API: api/fluent.md
    - JSONL: api/jsonl.md
    - CLI: api/cli.md
  - Development:
    - Contributing: development/contributing.md

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - footnotes
  - tables
  - def_list

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            docstring_style: google
            docstring_section_style: list
            filters: ["!^_"]
  - mkdocs-jupyter:
      include_source: true
      execute: false
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/queelius/fuzzy-infer
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fuzzy-infer/
  version:
    provider: mike
    default: stable

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js
  - javascripts/config.js