mkdocs.yml

repo_url: https://github.com/simonprovost/scikit-longitudinal
edit_uri: blob/main/docs/

site_name: Scikit-Longitudinal
site_author: Simon Provost
copyright: © Simon Provost 2024-present
site_description: >
  Scikit-Longitudinal is a machine learning library tailored to cope with
  longitudinal data in Longitudinal ML classification context. It is built on top of scikit-learn and provides
  tools to preprocess, model, and evaluate longitudinal data.

remote_branch: main

theme:
  name: 'material'
  custom_dir: 'docs/theme'
  favicon: 'assets/images/favicon.ico'
  logo: 'assets/images/ScikitLongitudinalLogo.png'
  icon:
    repo: fontawesome/brands/github
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: scikit_light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  font:
    text: Roboto
    code: Roboto Mono
  features:
    - announce.dismiss
    - content.tabs.link
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - navigation.tabs
    - navigation.top
    - search.suggest
    - toc.follow
    - toc.integrate


extra_css:
  - 'stylesheets/extra.css'
  - 'stylesheets/landing.css'

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - privacy
  - social
  - search
  - minify

extra:
  social:
      - icon: fontawesome/brands/github-alt
        link: https://github.com/simonprovost/
      - icon: fontawesome/brands/linkedin
        link: https://www.linkedin.com/in/simonprovostdev/
      - icon: fontawesome/brands/google-scholar
        link: https://scholar.google.com/citations?user=Lv_LddYAAAAJ
      - icon: fontawesome/brands/orcid
        link: https://orcid.org/0000-0001-8402-5464
      - icon: fontawesome/brands/researchgate
        link: https://www.researchgate.net/profile/Provost-Simon
      - icon: fontawesome/brands/stack-overflow
        link: https://stackoverflow.com/users/9814037/simon-provost
      - icon: fontawesome/solid/building-columns
        link: https://www.kent.ac.uk/computing/people/4973/provost-simon

markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      guess_lang: false
  - def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
        generic: true

nav:
  - "Home": index.md
  - "Quick Start": quick-start.md
  - "Temporal Dependency": temporal_dependency.md
  - "API Reference":
    - "Overview": API/index.md
    - "Data Preparation":
        - "Longitudinal Dataset": API/data_preparation/longitudinal_dataset.md
        - "Aggregation Function (AggrFunc)": API/data_preparation/aggregation_function.md
        - "Separate Waves (SepWav)": API/data_preparation/sepwav.md
        - "Merge Waves and discard features 'MervWavTime(-)'" : API/data_preparation/merwav_time_minus.md
        - "Merge Waves and keep features' Time indices 'MervWavTime(+)'": API/data_preparation/merwav_time_plus.md
    - "Pipeline":
      - "Longitudinal Pipeline": API/pipeline.md
    - "Preprocessors":
        - "Feature Selection":
            - "Correlation Feature Selection Per Group": API/preprocessors/feature_selection/correlation_feature_selection_per_group.md
    - "Estimators":
      - "Trees":
        - "Lexicographical Decision Tree Classifier": API/estimators/trees/lexico_decision_tree_classifier.md
        - "Lexicographical Decision Tree Regressor": API/estimators/trees/lexico_decision_tree_regressor.md
      - "Ensemble":
        - "Lexicographical Deep Forest": API/estimators/ensemble/lexico_deep_forest.md
        - "Lexicographical Gradient Boosting": API/estimators/ensemble/lexico_gradient_boosting.md
        - "Lexicographical Random Forest": API/estimators/ensemble/lexico_random_forest.md
        - "Nested Trees": API/estimators/ensemble/nested_trees.md
        - "Longitudinal Stacking": API/estimators/ensemble/longitudinal_stacking.md
        - "Longitudinal Voting": API/estimators/ensemble/longitudinal_voting.md
  - "Examples": examples/index.md
  - "Contributing": contribution.md
  - "Release History": https://github.com/simonprovost/scikit-longitudinal/releases
  - "FAQ": faq.md