datasmith/mkdocs.yml at main · formula-code/datasmith · 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
site_name: fc-data
site_url: https://formula-code.github.io/datasmith/
site_description: Python toolchain for building the FormulaCode benchmark
repo_url: https://github.com/formula-code/datasmith
repo_name: formula-code/datasmith

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  favicon: assets/favicon.svg
  logo: assets/logo.svg
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

exclude_docs: |
  archive/
  design/Datasmith - Overview.md
  design/archived/
  design/components/datasmith.*.md

validation:
  links:
    not_found: info

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["src"]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false
            filters:
              - "!^_"

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Pipeline (fc-data): guide/pipeline.md
      - Configuration: guide/configuration.md
      - Remote Access: guide/remote-access.md
      - Model Proxy: guide/model-proxy.md
  - User Guide:
      - Docker Images: guide/docker-images.md
      - Synthesis: guide/synthesis.md
      - Publishing: guide/publishing.md
      - Verification: guide/verification.md
      - Python API Quickstart: getting-started/quickstart.md
      - Monitoring: guide/monitoring.md