mkdocs.yml

site_name: Turftopic
site_description: 'An all-in-one library for topic modeling with sentence embeddings.'
repo_url: https://github.com/x-tabdeveloping/turftopic
nav:
  - Usage:
    - Getting Started: index.md
    - Using Turftopic: basics.md
    - Dynamic Topic Modeling: dynamic.md
    - Online Topic Modeling: online.md
    - Hierarchical Topic Modeling: hierarchical.md
    - Modifying and Finetuning Models: finetuning.md
    - Saving and Loading Models: persistence.md
  - Models:
    - Model Overview: model_overview.md
    - Semantic Signal Separation (S³): s3.md
    - KeyNMF: KeyNMF.md
    - GMM: GMM.md
    - Clustering Models: clustering.md
    - Autoencoding Models: ctm.md
    - FASTopic: FASTopic.md
  - Encoders: encoders.md
  - Namers: namers.md
theme:
  name: material
  logo: images/logo.svg
  navigation_depth: 3
  palette:
    primary: '#01034A'
  features:
      - toc.integrate
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.sections
      - navigation.expand
      - navigation.path
      - navigation.indexes
      - toc.follow
      - content.code.copy

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          annotations_path: brief
          show_root_heading: true
          show_root_toc_entry: false
          show_symbol_type_heading: true
          docstring_style: numpy
          heading_level: 3

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      toc_depth: 2
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


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