mkdocs.yml

# Settings are inspired by
# https://github.com/patrick-kidger/equinox/blob/main/mkdocs.yml
site_name: PDEquinox
site_description: Neural PDE Emulator Architectures in JAX & Equinox.
site_author: Felix Koehler
site_url: https://fkoehler.site/pdequinox

repo_url: https://github.com/Ceyron/pdequinox
repo_name: Ceyron/pdequinox
edit_uri: ""  # No edit button, as some of our pages are in /docs and some in /examples via symlink, so it's impossible for them all to be accurate

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:
        - scheme: default
          primary: indigo
          accent: amber
          toggle:
             icon: material/weather-night
             name: Switch to dark mode
        - scheme: slate
          primary: indigo
          accent: amber
          toggle:
             icon: material/weather-sunny
             name: Switch to light mode
    icon:
        repo: fontawesome/brands/github  # GitHub logo in top right

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/felix_m_koehler
    - icon: fontawesome/brands/github
      link: https://github.com/ceyron
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/@MachineLearningSimulation


strict: true  # Don't allow warnings during the build process

markdown_extensions:
    - pymdownx.arithmatex:  # Render LaTeX via MathJax
        generic: true
    - pymdownx.superfences  # Seems to enable syntax highlighting when used with the Material theme.
    - pymdownx.details  # Allowing hidden expandable regions denoted by ???
    - pymdownx.snippets:  # Include one Markdown file into another
        base_path: docs
    - admonition
    - toc:
        permalink: "¤"  # Adds a clickable permalink to each section heading
        toc_depth: 4
    - pymdownx.arithmatex:
        generic: true

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:
    - search  # default search plugin; needs manually re-enabling when using any other plugins
    - autorefs  # Cross-links to headings
    - mknotebooks  # Jupyter notebooks
    - mkdocstrings:
        handlers:
            python:
                options:
                    inherited_members: true  # Allow looking up inherited methods
                    show_root_heading: true  # actually display anything at all...
                    show_root_full_path: true  # display "diffrax.asdf" not just "asdf"
                    show_if_no_docstring: true
                    show_signature_annotations: true
                    separate_signature: true
                    show_source: true  # don't include source code
                    members_order: source  # order methods according to their order of definition in the source code, not alphabetical order
                    heading_level: 4
                    show_symbol_type_heading: true
                    docstring_style: null

nav:
    - 'index.md'
    - 'more_details.md'
    - Examples:
        - Introductory:
            - Train UNet as Poisson Emulator: 'examples/train_unet_as_poisson_solver.ipynb'
            - Parameter Counting & Receptive Field: 'examples/parameter_count_and_receptive_field.ipynb'
            - Architecture Showcase: 'examples/architecture_showcase.ipynb'
        - Advanced:
            - Seed Parallel Training: 'examples/seed_parallel_training.ipynb'
    - High-Level API:
        - Architectures:
            - MLP: 'api/arch/mlp.md'
            - Conv: 'api/arch/conv.md'
            - ResNet: 'api/arch/resnet.md'
            - UNet: 'api/arch/unet.md'
            - Dilated: 'api/arch/dilated.md'
            - FNO: 'api/arch/fno.md'
        - Utilities: 'api/utils.md'
        - Sample Data: 'api/sample_data.md'
    - Low-Level API:
        - Arch Constructors: 'api/arch_constructors.md'
        - Blocks: 'api/blocks.md'
        - Block Factories: 'api/block_factories.md'
        - Conv: 'api/conv.md'