DeepLens/mkdocs.yml at main · vccimaging/DeepLens · 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
site_name: DeepLens
site_description: "Differentiable optical lens simulator for end-to-end camera system design with PyTorch"
site_author: "Xinge Yang"
site_url: https://vccimaging.github.io/DeepLens/
repo_url: https://github.com/singer-yang/DeepLens
repo_name: singer-yang/DeepLens

docs_dir: docs

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  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.top
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            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

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.arithmatex:
      generic: true
  - tables
  - attr_list

extra_css:
  - stylesheets/api.css

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

nav:
  - Home:
      - Overview: index.md
      - Installation: installation.md
      - Quickstart: quickstart.md
      - Architecture: architecture.md
  - API Reference:
      - Optics: api/optics.md
      - Surrogate Networks: api/network.md
  - Examples: examples.md
  - Contributing: contributing.md