site_name: Cupid Matching

site_url: https://github.pages.io/bsalanie/cupid_matching

repo_url: https://github.com/bsalanie/cupid_matching

theme:
  palette:
    scheme: preference
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - search.highlight
    - navigation.expand
    - navigation.tabs
#   custom_dir: "docs/overrides"

plugins:
  - search
  - mkdocstrings
#  - git-revision-date

markdown_extensions:
  - attr_list
  - pymdownx.superfences
  - pymdownx.highlight:
      linenums: true
  - toc:
      permalink: true
  - admonition # add notes, warnings...
  - codehilite
  - toc
  - pymdownx.arithmatex # for LaTeX
extra_javascript: # for arithmatex
  - "https://polyfill.io/v3/polyfill.min.js?features=es6"
  - "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"

nav:
  - Home: index.md
  #    - Installation: installation.md
  #    - Usage: usage.md
  #    - Contributing: contributing.md
  #    - FAQ: faq.md
  # - Report Issues: https://github.com/bsalanie/bs_cupid_try/issues
  - API Reference:
      - Minimum Distance Estimator: min_distance.md
      - Utilities for MDE: min_distance_utils.md
      - Poisson estimator: poisson_glm.md
      - Utilities for Poisson: poisson_glm_utils.md
      - Entropy utilities: entropy.md
      - Choo-Siow homoskedastic: choo_siow.md
      - Choo-Siow Gender-heteroskedastic: choo_siow_gender_heteroskedastic.md
      - Choo-Siow Heteroskedastic: choo_siow_heteroskedastic.md
      - Nested Logit: nested_logit.md
      - IPFP solvers: ipfp_solvers.md
      - Utilities for Matching: matching_utils.md
      - General Utilities: utils.md
      - Classes used: model_classes.md
      - Example on the Choo and Siow model: example_choosiow.md
      - Example on a nested logit model: example_nestedlogit.md
      - Code for a Streamlit app: cupid_streamlit.md
