mkdocs.yml

# Project information
site_name: AI Function
site_url: https://WecoAI.github.io/aifn-python
site_author: Weco AI
site_description: >-
  Documentation for `aifn`, a client-side API for interacting with Weco AI's AI functions.
docs_dir: docs
site_dir: site
use_directory_urls: true

# Repository
repo_name: aifn-python
repo_url: https://github.com/WecoAI/aifn-python
remote_branch: gh-pages
remote_name: origin

# Copyright
copyright: Copyright © 2024 Weco AI

# Configuration
theme:
  name: material
  locale: en
  custom_dir: .overrides
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - navigation.collapse
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - social
  palette:
    - scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Dark Mode

    - scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Light Mode
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    logo: custom/weco
  favicon: assets/weco.svg
  include_homepage_in_sidebar: true
  highlightjs: true
  hijs_languages:
    - python

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [aifn]
          options:
            docstring_style: numpy
            separate_signature: true
            show_signature_annotations: false
            show_source: false
            heading_level: 2
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true

# Customization
extra:
  social:
    - icon: fontawesome/solid/house
      link: https://weco.ai/
    - icon: fontawesome/brands/github-alt
      link: https://github.com/WecoAI/aifn-python
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/WecoAI
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/weco-ai/
    
extra_javascript:
  - javascripts/katex.js 
  - javascripts/mathjax.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js  # (1)!
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - stylesheets/extra.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

# Extensions
markdown_extensions:
  - toc:
      permalink: true
      separator: "_"
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - attr_list
  - md_in_html
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.blocks.caption

# Page tree
nav: 
  - 'About': index.md

  - 'Getting Started' :
    - 'Installation' : 'getting_started/installation.md'
    - 'Introduction' : 'getting_started/introduction.md'

  - 'User Guide':
    - 'Cookbook': 'cookbook/cookbook.md'
    - 'Examples':
      - 'Maze Runner': 'cookbook/examples/maze_runner.md'

  - 'API Reference': 'api/api.md'

  - 'Contributing': contributing.md