mkdocs.yml

site_name: CliffordLayers
site_description: Documentation for CliffordLayers
repo_name: microsoft/cliffordlayers
edit_uri: edit/main/docs
repo_url: https://github.com/microsoft/cliffordlayers

markdown_extensions:
  - attr_list
  - tables
  - admonition
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: "¤"
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
theme:
  name: material
  palette:
    scheme: clifford
  features:
    - content.code.annotate
  custom_dir: docs/overrides
  font:
    text: Merriweather Sans
    code: Noto Sans Mono
  logo: assets/images/logo.png

extra_css:
  - css/extra.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://pytorch.org/docs/stable/objects.inv

nav:
  - Home: "index.md"
  - Installation: "install.md"
  - Research: "research.md"
  - Code reference:
    - Modules: "reference/modules.md"
    - Functional: "reference/functional.md"
    - Internals: "reference/misc.md"
    - Models: "reference/models.md"