mkdocs.yml

# mkdocs.yml
site_name: heavylight

theme:
    name: material
    features:
        - navigation.sections  # Sections are included in the navigation on the left.
        - toc.integrate  # Table of contents is integrated on the left; does not appear separately on the right.
        - header.autohide  # header disappears as you scroll
    palette:
        # Light mode / dark mode
        # We deliberately don't automatically use `media` to check a user's preferences. We default to light mode as
        # (a) it looks more professional, and (b) is more obvious about the fact that it offers a (dark mode) toggle.
        - scheme: default
          primary: white
          accent: amber
          toggle:
             icon: material/weather-night
             name: Switch to dark mode
        - scheme: slate
          primary: black
          accent: amber
          toggle:
             icon: material/weather-sunny
             name: Switch to light mode
    icon:
        repo: fontawesome/brands/github  # GitHub logo in top right
        logo: "material/flash"  # Equinox logo in top left
    # favicon: "_static/favicon.png"

markdown_extensions:
    - pymdownx.highlight:
        anchor_linenums: true
        line_spans: __span
        pygments_lang_class: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
    - pymdownx.details
    - admonition
    - toc:
        permalink: "¤"  # Adds a clickable permalink to each section heading
        toc_depth: 4

repo_url: https://github.com/lewisfogden/heavylight

plugins:
    - mkdocs-jupyter
    - autorefs
    - search
    - mkdocstrings:
        handlers:
            python:
                options:
                    show_signature_annotations: true
                    show_root_heading: true
                    show_source: false
                    members_order: source
strict: true  # Don't allow warnings during the build process

extra_javascript: 
    # The below three make MathJax work, see https://squidfunk.github.io/mkdocs-material/reference/mathjax/
    - _static/mathjax.js
    - https://polyfill.io/v3/polyfill.min.js?features=es6
    - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
    - _static/custom_css.css

nav:
    - 'index.md'
    - 'tables.md'
    - Guides:
        - Introductory Guide: getting_started/intro_to_heavylight.ipynb
        - Heavylight Tables: getting_started/heavylight_tables.ipynb
    - API:
        - Model: api/heavylight_Model.md
        - Table: api/heavylight_Table.md
        - LightModel: api/lightmodel.md
    - Theory: 
        - Recursive life insurance: theory/recursive_life_insurance.ipynb
        - Vectorized models: theory/vectorized_models.ipynb
        - Memory optimizations: theory/memory_optimization.md
    - Experiments:
        - Rendering a model graph: experiments/term_assurance_graph.html