docs/mkdocs.yml at main · AI4Optics/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
site_name: AI4Optics
site_description: "Differentiable optics for end-to-end imaging system design — documentation for the AI4Optics family of projects (DeepLens and more)."
site_author: "Xinge Yang"
site_url: https://ai4optics.github.io/docs/

# Default top-right header link (umbrella home and any non-project page): the
# AI4Optics org. On project pages this is overridden per-project by
# overrides/partials/source.html — DeepLens pages link to the DeepLens repo,
# End2endImaging pages to the End2endImaging repo.
repo_url: https://github.com/AI4Optics
repo_name: AI4Optics

docs_dir: docs

theme:
  name: material
  custom_dir: overrides
  language: en
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.follow
    - search.highlight
    - search.suggest
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [deeplens-src, end2endimaging-src, difftmm-src]
          options:
            allow_inspection: false
            docstring_style: google
            show_source: true
            show_root_heading: true
            members_order: source
            heading_level: 3
            separate_signature: true
            merge_init_into_class: true
            show_signature_annotations: true

# Build-time hook: fetches each project's GitHub stars/forks and exposes them as
# config.extra.repo_facts, rendered statically into the header by source.html.
hooks:
  - hooks/repo_facts.py

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - attr_list
  - md_in_html

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

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Overview: index.md
  - DeepLens:
      - Overview: deeplens/index.md
      - Get Started:
          - Setup: deeplens/setup.md
          - Quickstart: deeplens/quickstart.md
          - Architecture: deeplens/architecture.md
          - Installation: deeplens/installation.md
      - API Reference:
          - Overview: deeplens/api/index.md
          - Lens Models:
              - Lens: deeplens/api/lens.md
              - GeoLens: deeplens/api/geolens.md
              - HybridLens: deeplens/api/hybridlens.md
              - DiffractiveLens: deeplens/api/diffraclens.md
              - DefocusLens: deeplens/api/defocuslens.md
              - PSFNetLens: deeplens/api/psfnetlens.md
          - Optics Core: deeplens/api/core.md
          - Surrogate Networks: deeplens/api/network.md
      - Examples:
          - Overview: deeplens/examples/index.md
          - Getting Started:
              - GeoLens: deeplens/examples/hello_geolens.md
              - DefocusLens: deeplens/examples/hello_defocuslens.md
              - DiffractiveLens: deeplens/examples/hello_diffraclens.md
              - HybridLens: deeplens/examples/hello_hybridlens.md
          - Lens Design:
              - GeoLens: deeplens/examples/design_geolens.md
              - DiffractiveLens: deeplens/examples/design_diffraclens.md
              - HybridLens: deeplens/examples/design_hybridlens.md
          - Advanced:
              - Automated Lens Design: deeplens/examples/autolens_rms.md
              - PSF Network: deeplens/examples/psf_net.md
              - 4f System: deeplens/examples/4f_system.md
              - Pupil Field: deeplens/examples/pupil_field.md
              - Multi-order Diffraction: deeplens/examples/multi_order.md
              - Diffractive Surfaces: deeplens/examples/diffractive_surfaces.md
      - Citation: deeplens/citation.md
  - End2endImaging:
      - Overview: end2endimaging/index.md
      - Get Started:
          - Setup: end2endimaging/setup.md
          - Quickstart: end2endimaging/quickstart.md
          - Architecture: end2endimaging/architecture.md
      - API Reference:
          - Overview: end2endimaging/api/index.md
          - Camera: end2endimaging/api/camera.md
          - DeepLens: end2endimaging/api/optics.md
          - Sensor: end2endimaging/api/sensor.md
          - Network: end2endimaging/api/network.md
      - Examples:
          - Overview: end2endimaging/examples/index.md
          - Computational Photography: end2endimaging/examples/comp_photography.md
          - Defocus Deblur: end2endimaging/examples/defocus_deblur.md
          - End-to-End Lens Design: end2endimaging/examples/end2end_lens_design.md
          - Task-Driven Lens Design: end2endimaging/examples/task_driven.md
      - Citation: end2endimaging/citation.md
  - DiffTMM:
      - Overview: difftmm/index.md
      - Get Started:
          - Setup: difftmm/setup.md
          - Quickstart: difftmm/quickstart.md
          - Architecture: difftmm/architecture.md
      - API Reference:
          - Overview: difftmm/api/index.md
          - Isotropic Solver: difftmm/api/isotropic.md
          - Anisotropic Solver: difftmm/api/anisotropic.md
          - Incoherent Solver: difftmm/api/incoherent.md
          - Materials: difftmm/api/material.md
      - Examples:
          - Overview: difftmm/examples/index.md
          - Benchmarks: difftmm/examples/benchmarks.md
          - Forward Simulation: difftmm/examples/forward_simulation.md
          - Inverse Design: difftmm/examples/inverse_design.md
          - Real Materials: difftmm/examples/real_materials.md
          - Incoherent Films: difftmm/examples/incoherent_films.md
      - Citation: difftmm/citation.md

  - Applications:
      - Hyperspectral Imaging:
          - Overview: hyperspectral/index.md
          - Examples:
              - Overview: hyperspectral/examples/index.md
              - Diffractive Surfaces: hyperspectral/examples/diffractive_surfaces.md
              - HSI Reconstruction: hyperspectral/examples/hsi_reconstruction.md
              - End-to-End Design: hyperspectral/examples/end2end_hsi.md
          - Citation: hyperspectral/citation.md
  - Contribute:
      - Overview: contribute/index.md
      - Development Setup: contribute/setup.md
      - Pull Requests: contribute/pull-requests.md
      - Building Documentation: contribute/documentation.md
      - Code of Conduct: contribute/code-of-conduct.md