mkdocs.yml

site_name: adaXT
site_url: https://niklaspfister.github.io/adaXT/

repo_url: https://github.com/NiklasPfister/adaXT
repo_name: "adaXT"
watch: [mkdocs.yml, README.md, src/adaXT]
site_description: Adaptable and Extendable Decision Trees

plugins:
  - search:
  - autorefs:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            show_bases: false
            # Filters off all private methods defined with __, when importing
            filters: ["!^_"]
            show_source: false
            show_root_heading: false
            merge_init_into_class: true
            show_docstring_attributes: true
            line_length: 60
            separate_signature: true

theme:
  name: "material"
  features:
    - navigation.sections
    - navigation.expand
    - content.code.annotate
    - content.code.copy
    - content.tooltips

  # Adding dark mode
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to system preference

# Navigation bar on the left
nav:
  - Overview: index.md
  - User Guide:
      - Installation: user_guide/installation.md
      - Existing functionality:
          - Decision trees: user_guide/decision_tree.md
          - Random forests: user_guide/random_forest.md 
          - Honest splitting: user_guide/honest_splitting.md
          - Tree-based weights: user_guide/tree_based_weights.md
          - Visualizing and analysis tools: user_guide/vis_and_analysis.md
          - Using scikit-learn functionality: user_guide/scikit_learn.md
      - Modifying and extending:
          - Overview of components: user_guide/overview_components.md
          - Creating custom criteria: user_guide/creatingCriteria.md
          - Creating custom prediction: user_guide/creatingPredictor.md
  - API reference:
      - DecisionTree: api_docs/DecisionTree.md
      - RandomForest: api_docs/RandomForest.md
      - Criteria: api_docs/Criteria.md
      - Predictor: api_docs/Predictor.md
      - Nodes: api_docs/Nodes.md
      - LeafBuilder: api_docs/LeafBuilder.md
      - Splitter: api_docs/Splitter.md
      - Tree utilities: api_docs/tree_utils.md
      - Parallel: api_docs/Parallel.md

# For setting up math and code blocks
markdown_extensions:
  # Math block setup
  - pymdownx.arithmatex:
      generic: true

  - toc:
      permalink: "#"

  # Code block setup
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  - pymdownx.snippets:
# Also for math
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