mkdocs.yml

# Great resources: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#with-section-index-pages
# https://squidfunk.github.io/mkdocs-material/reference/buttons/
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/


theme:
  name: material
  features:
    - navigation.sections
    - navigation.path
    - navigation.indexes 
    - navigation.top
    - content.code.copy

  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/telescope
    favicon: material/telescope

site_name: dLux
docs_dir: docs/
site_description: Documentation for dLux.
site_author: Louis Desdoigts
site_url: https://louisdesdoigts.github.io/dlux/
repo_url: https://github.com/LouisDesdoigts/dlux
repo_name: louisdesdoigts/dlux
edit_uri: "" 

strict: true # Prevent builds with warnings

plugins:
  - mkdocs-jupyter
  - search
  - same-dir
  - autorefs
  - simple:
      ignore:
        - tests
        - src
        - build
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: "numpy"
          rendering:
            members_order: source

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.extra
  - toc:
      toc_depth: 2

# ===== Navigation =====
nav:
    - Home: README.md

    - Tutorials:
        - Introductory:
            - A Basic Overview:         tutorials/introductory/overview.md
            - Optical Systems:          tutorials/introductory/optical_systems.md
            - Sources & Spectra:        tutorials/introductory/sources.md
            # - Detectors:
            # - Building Telescope:
            # - Building a coronagraph:
            # - The Wavefront and PSF classes:
            # - functional psf modelling with the Utils module:

              
        - How-To's:
            - Working with dLux objects: tutorials/howtos/dLux_objects.md
            - Building Apertures:        tutorials/howtos/custom_apertures.md
            # - Optimisation with dLux (Optimising many parameters, arbitrary loss functions):
            # - Estimating Uncertainties (Fisher Information):
            # - Sampling Posteriors (HMC):
            # - Building your own classes (optical system, source): 

            
        - Examples:
            - Phase Retrieval:          tutorials/examples/phase_retrieval_demo.md
            - Phase Mask Design:        tutorials/examples/designing_a_mask.md
            - Pixel Level Calibration:  tutorials/examples/flatfield_calibration.md
            - Fisher Information:       tutorials/examples/fisher_information.md
            - Parameter Inference:      tutorials/examples/HMC.md

    - API:
    
        - Core API:
            # - Overview:         API/core/core.md
            - Wavefronts:       API/core/wavefronts.md
            - Optical Systems:  API/core/optical_systems.md
            - Spectra:          API/core/spectra.md
            - Sources:          API/core/sources.md
            - PSFs:             API/core/psfs.md
            - Detectors:        API/core/detectors.md
            - Instruments:      API/core/instruments.md
            - Transformations:  API/core/transformations.md

        - Layers API:
            # - Overview:        API/layers/layers.md
            - Optical Layers:   API/layers/optical_layers.md
            - Optics:           API/layers/optics.md
            - Propagators:      API/layers/propagators.md
            - Apertures:        API/layers/apertures.md
            - Aberrations:      API/layers/aberrations.md
            - Detector Layers:  API/layers/detector_layers.md
            - Unified Layers:   API/layers/unified_layers.md

        - Utils API:
            # - Overview:      API/utils/utils.md
            - Array Operations: API/utils/array_ops.md
            - Coordinates:      API/utils/coordinates.md
            - Geometry:         API/utils/geometry.md
            - Helpers:          API/utils/helpers.md
            - Interpolation:    API/utils/interpolation.md
            - Math:             API/utils/math.md
            - Optics:           API/utils/optics.md
            - Propagation:      API/utils/propagation.md
            - Source:           API/utils/source.md
            - Units:            API/utils/units.md
            - Zernikes:         API/utils/zernikes.md
            

    - FAQ & Troubleshooting: faq.md
    - Change Log: CHANGELOG.md
    - Contributing: CONTRIBUTING.md