site_name: Survey-Kit
repo_url: https://github.com/jrothbaum/survey_kit
watch:
  - src/survey_kit
nav:
  - Home: index.md
  - User Guide:
    - Calibration: user-guide/calibration.md
    - Imputation/SRMI: user-guide/srmi.md
    - Statistics/Standard Errors: user-guide/statistics.md
  - API Reference:
    - Calibration: api/calibration.md
    - Imputation/SRMI: api/srmi.md
    - Basic Statistics/Standard Errors: api/basic_standard_errors.md
    - Multiple Imputation Standard Errors: api/multiple_imputation.md
    - Miscellaneous: api/miscellaneous.md
theme:
  name: material
  font: false
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.footer
    - navigation.indexes
    - navigation.top
  palette:   
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference


plugins:
- autorefs
- search: 
    # See https://squidfunk.github.io/mkdocs-material/plugins/search/#configuration
    enabled: true
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        inventories:
        - https://installer.readthedocs.io/en/stable/objects.inv
        options:
          show_signature_annotations: true
          members_order: alphabetical
          separate_signature: true
          filters:
              - "!^_"  # Hide private members by default
          inherited_members: false
          docstring_style: numpy
    enable_inventory: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: 
        - '.'
        - 'docs'
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascript/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js