mkdocs.yml

site_name: FUES
site_description: >-
  A fast upper envelope scan method for discrete–continuous dynamic programming.
  Dobrescu and Shanker (2022).
site_author: Loretti I. Dobrescu and Akshay Shanker
site_url: https://akshayshanker.github.io/FUES/
repo_url: https://github.com/akshayshanker/FUES
repo_name: akshayshanker/FUES
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: IBM Plex Sans
    code: JetBrains Mono
  logo: images/fues-logo.svg
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil-outline
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  - pymdownx.mark
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.smartsymbols
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
      permalink_title: "Link to this section"

plugins:
  - search:
      lang: en
  - mkdocs-jupyter:
      include_source: true
      ignore_h1_titles: true
      execute: false

extra_javascript:
  - javascripts/mathjax.js
  - javascripts/fues-interactive.js
  - https://cdn.plot.ly/plotly-2.35.2.min.js
  # - javascripts/thebe-config.js?v=8  # disabled: static docs, no live kernel
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

copyright: >-
  © 2022–2026 Akshay Shanker —
  Logo font: TNG Title by Ukraine Fonts

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/akshayshanker/FUES
      name: Source code on GitHub
    - icon: fontawesome/solid/file-lines
      link: https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4181302
      name: Working paper on SSRN

nav:
  - Home: index.md
  - Quickstart: start-here/quickstart.md

  - The FUES algorithm: algorithm/fues-algorithm.md

  - Applications:
    - Overview: examples/index.md
    - Retirement choice: examples/retirement_choice_model.md
    - Continuous housing: examples/continuous_housing_model.md
    - Housing-renting (draft): examples/housing-renting.md

  - Notebooks:
    - EGM / FUES walkthrough: notebooks/egm_fues_transparent.ipynb
    - Retirement choice: notebooks/retirement_fues.ipynb
    - Durables (Cobb–Douglas): notebooks/durables_fues.ipynb
    - Durables (separable): notebooks/durables_fues_separable.ipynb

  - Reproducibility:
    - Overview: reproducibility/index.md
    - Running locally: running-locally.md
    - Running on a PBS cluster: running-on-gadi.md

  - Reference:
    - Installation: getting-started/installation.md
    - Core API: api/fues.md
    - Retirement internals: api/retirement.md
    - Changelog: changelog.md