mkdocs.yml

site_name: Torch Lens Maker

repo_name: victorpoughon/torchlensmaker
repo_url: https://github.com/victorpoughon/torchlensmaker
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - navigation.footer
    - content.action.edit
    # - toc.integrate
  palette:
    - scheme: default
      primary: orange
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: orange
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  logo: tlmlogo_black150.png


extra_css:
  - stylesheets/extra.css
  - stylesheets/jupyter.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - md_in_html
  - attr_list

plugins:
  - search
  - mkdocs-jupyter

nav:
  - Home:
    - Overview: index.md
    - Installation: installation.md
    - How does it work?: how.md
    - Roadmap: roadmap.md
  - Examples:
    - Simple Lenses:
      - Simple Lenses: examples/executed/simple_lenses.ipynb
      - Biconvex lens (sphere): examples/executed/Biconvex lens sphere.ipynb
      - Biconvex lens (parabola): examples/executed/Biconvex lens parabola.ipynb
      - Biconvex lens (bezier spline): examples/executed/Biconvex lens bezier spline.ipynb
      - Biconcave diverging lens: examples/executed/Biconcave diverging lens.ipynb
      - Planoconvex lens (sphere): examples/executed/Planoconvex lens (sphere).ipynb
      - Planoconvex lens (piecewise line): examples/executed/Planoconvex lens (piecewise line).ipynb
      - Landscape Singlet Lens: examples/executed/landscape_singlet_lens.ipynb

    - Multiple Lenses:
      - Variable number of lenses: examples/executed/Multiple Lenses Sequence.ipynb
      - Triple Lens: examples/executed/Triple Biconvex lens parabola.ipynb
      - Optimization without tlm.Module: examples/executed/Biconvex Parabola - No tlmModule.ipynb
      - Moving a lens to focus: examples/executed/Moving a lens to focus.ipynb
      - Regularization - Equal Thickness Lenses: examples/executed/Regularization - Equal Thickness Lenses.ipynb
  
    - Mirrors:
      - Reflecting Telescope: examples/executed/Reflecting Telescope.ipynb
      - Concave Mirror: examples/executed/Concave Mirror.ipynb
    
    - Optics:
      - Aperture: examples/executed/Aperture.ipynb
      - Surface Anchors: examples/executed/Surface anchors.ipynb

  - Reference:
    - Shapes: reference/shapes.md
    - Lenses: reference/lenses.md