rapidata-python-sdk/mkdocs.yml at main · RapidataAI/rapidata-python-sdk · 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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
site_name: Rapidata Python SDK
site_url: https://docs.rapidata.ai/
repo_url: https://github.com/RapidataAI/rapidata-python-sdk
repo_name: rapidata-python-sdk
extra_javascript:
  - js/tawk.js
  - js/login.js
  - js/ai-copy-button.js
extra_css:
  - https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;600;700&display=swap
  - stylesheets/extra.css

hooks:
  - hooks/search_boost.py

plugins:
  - search
  - mike
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      width: 100%
      height: auto
  - autorefs:
      resolve_closest: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src/rapidata/rapidata_client]
          rendering:
            show_source: true
          selection:
            docstring_style: google
          options:
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            members_order: source
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_if_no_docstring: false
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - redirects:
      redirect_maps:
        'index.md': 'starting_page.md'
  - llmstxt-md:
      sections:
        Guides:
          - starting_page.md
          - quickstart.md
          - audiences.md
          - job_definition_parameters.md
          - understanding_the_results.md
          - error_handling.md
          - confidence_stopping.md
          - human_prompting.md
          - config.md
        Examples:
          - examples/classify_job.md
          - examples/compare_job.md
        Benchmarks:
          - mri.md
          - mri_advanced.md
        Flows:
          - flows.md
        AI Agents:
          - ai_agents.md
      enable_markdown_urls: true
      enable_llms_txt: true
      enable_llms_full: true
      enable_copy_button: true
      copy_button_text: "Copy for AI"

extra:
  version:
    provider: mike

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

nav:
    - Guides:
      - Overview: starting_page.md
      - Quick Start: quickstart.md
      - Custom Audiences: audiences.md
      - Parameter Reference: job_definition_parameters.md
      - Understanding Results: understanding_the_results.md
      - Early Stopping: confidence_stopping.md
      - Instruction Design: human_prompting.md
      - Error Handling: error_handling.md
      - Logging & Config: config.md
    - Examples:
      - Classification: examples/classify_job.md
      - Comparison: examples/compare_job.md
    - Ranking Flows: flows.md
    - Model Ranking:
      - Getting Started: mri.md
      - Advanced: mri_advanced.md
    - AI Agents: ai_agents.md

theme:
  name: material
  logo: media/rapidata.svg
  favicon: media/rapidata.svg
  font: false
  palette:
    - scheme: slate
      primary: black
      accent: blue

  icon:
    repo: fontawesome/brands/github-alt
    admonition:
      note: octicons/info-16
      tip: octicons/light-bulb-16
      warning: octicons/alert-16
      danger: octicons/x-circle-16
      example: octicons/code-16

  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight