gsim/mkdocs.yml at main · gdsfactory/gsim · 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
site_name: gsim
site_url: https://gdsfactory.com/gsim
site_description: Simulations API for GDSFactory
site_author: GDSFactory
copyright: Copyright © 2026, GDSFactory
repo_url: https://github.com/gdsfactory/gsim
repo_name: gdsfactory/gsim
theme:
  name: shadcn
  custom_dir: docs/overrides
  pygments_style:
    light: github-light
    dark: github-dark
extra_css:
  - assets/custom.css
nav:
  - home: index.md
  - FDTD for Photonics:
      - Y-Branch: nbs/meep_ybranch.md
      - Ring Coupler: nbs/meep_ring_coupler.md
      - Directional Coupler: nbs/meep_dc.md
      - Crossing: nbs/meep_crossing.md
      - 2D FDTD: nbs/meep_2d.md
  - FEM for RF:
      - CPW (Lumped Ports): nbs/palace_cpw_lumped.md
      - CPW (Wave Ports): nbs/palace_cpw_waveport.md
      - Microstrip: nbs/palace_microstrip.md
      - Branch Line Coupler: nbs/palace_branch_line_coupler.md
      - "Parallel Simulations: Width Sweep": nbs/palace_width_sweep.md
      - QPDK Resonator: nbs/palace_qpdk_resonator.md
      - CPW Via Transition: nbs/palace_cpw_via.md
      - Field Visualization: nbs/palace_cpw_fields.md
  - API Reference:
      - Palace: api/palace.md
      - Meep: api/meep.md
      - Common: api/common.md
      - Cloud: api/cloud.md
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            docstring_style: google
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            line_length: 88
            merge_init_into_class: true
            separate_signature: true
            show_root_full_path: false
            show_root_heading: true
            show_signature_annotations: true
            show_source: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
markdown_extensions:
  - attr_list
  - codehilite
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      css_class: codehilite
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.magiclink
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
hooks:
  - docs/hooks.py