mkdocs.yml

site_name: Rapidata Python SDK Documentation
site_url: https://docs.rapidata.ai/
repo_url: https://github.com/RapidataAI/rapidata-python-sdk
repo_name: rapidata-python-sdk

plugins:
  - search
  - mike
  - 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
  
extra:
  version:
    provider: mike

markdown_extensions:
  - attr_list
  - sane_lists
  - md_in_html
  - toc:
      permalink: "#"
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - 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:
  - Overview: index.md
  - quickstart.md
  - Understanding the Results: understanding_the_results.md
  - Improve Quality: improve_order_quality.md
  - Improve Efficency: confidence_stopping.md
  - Examples:
    - Classification: examples/classify_order.md
    - Compare: examples/compare_order.md
    - Free Text: examples/free_text_order.md
    - SelectWords:
      - Faulty Words: examples/select_faulty_prompt_order.md
      - Text to Speech: examples/select_words_order.md
  - Filters: reference/rapidata/rapidata_client/filter/rapidata_filters/
  - Settings: reference/rapidata/rapidata_client/settings/rapidata_settings/
  - Selections: reference/rapidata/rapidata_client/selection/rapidata_selections/
  - API Documentation: api.md

theme:
  name: material
  logo: media/rapidata.svg
  favicon: media/rapidata.svg
  palette:
    # Palette toggle for dark mode (default)
    - scheme: slate
      accent: cyan
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Palette toggle for light mode
    - scheme: default
      accent: cyan
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  icon:
    repo: fontawesome/brands/github-alt

  features:
    - content.code.copy