mkdocs.yml

site_name: neighbors
site_description: "A Python package to perform collaborative filtering on social and emotion datasets"
site_url: "https://cosanlab.github.io/neighbors"
repo_url: "https://github.com/cosanlab/neighbors"
repo_name: "cosanlab/neighbors"
theme:
  name: material
markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
nav:
  - Home: index.md
  - Tutorials:
      - 1) Working with Dense Data: examples/dense-data
      - 2) Working with Sparse Data: examples/sparse-data
      - 3) Working with Time-Series: examples/timeseries-data
  - Contributing to Development: development.md
  - Release Notes: releasenotes.md
  - API Reference:
      - neighbors.models:
          - Mean: api/mean.md
          - KNN: api/knn.md
          - NNMF_mult: api/nmf_m.md
          - NNMF_sgd: api/nmf_s.md
      - neighbors.utils: api/utils.md
plugins:
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          selection:
            inherited_members: True
          filters:
            - "^__init__$"
          rendering:
            show_source: true
            show_if_no_docstring: False
            show_root_toc_entry: True
            show_root_members_full_path: True
            show_category_heading: False
            heading_level: 4
      watch:
        - neighbors
extra:
  analytics:
    provider: google
    property: G-1N98SJ70M6