sax/mkdocs.yml at a06ddfefd60c35e8b26bbd0e085a31293b49dfbc · sequoiap/sax · 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
site_name: sax
repo_url: https://github.com/flaport/sax
site_url: https://flaport.github.io/sax
site_description: Autograd and XLA for S-parameters
site_author: Floris Laporte
repo_name: flaport/sax
copyright: Copyright © 2025, Floris Laporte, Apache-2.0

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: blue
      accent: deep purple
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system default
      primary: blue
      accent: deep purple
  features:
    - content.code.copy
    - navigation.footer
  search: true

nav:
  - home: index.md
  - examples:
      - quick start: nbs/examples/01_quick_start.md
      - all pass: nbs/examples/02_all_pass_filter.md
      - circuit from yaml: nbs/examples/03_circuit_from_yaml.md
      - multimode: nbs/examples/04_multimode_simulations.md
      - thin film:  nbs/examples/05_thinfilm.md
      - additive: nbs/examples/06_additive_backend.md
      - layout aware: nbs/examples/07_layout_aware.md
      - sparse (coo): nbs/examples/08_sparse_coo.md
      - forward only:  nbs/examples/09_forward_only_backend.md
      - neff dispersion: nbs/examples/10_wavelength_dependent_neff.md
      - hierarchical circuits: nbs/examples/11_hierarchical_circuits.md
      - data parsers: nbs/examples/12_data_parsers.md
      - surface models: nbs/examples/13_surface_models.md
      - probes: nbs/examples/14_probes.md
      - multi link: nbs/examples/15_multi_link.md
  - internals:
      - backends: nbs/internals/03_backends.md
      - circuit: nbs/internals/02_circuit.md
      - models: nbs/internals/01_models.md
      - all models: nbs/internals/04_all_models.md
  - api reference:
      - sax: api.md
      - sax.fit: fit.md
      - sax.models: models.md
      - sax.models.rf: models_rf.md
  - changelog: changelog.md

extra_css:
  - assets/custom.css

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

plugins:
  - search
  - autorefs
  - mkdocs_matplotlib
  - bibtex:
      bib_file: "docs/references.bib"
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.jax.dev/en/latest/objects.inv
            - https://docs.kidger.site/jaxtyping/objects.inv
            - https://docs.python.org/3/objects.inv
            - https://docs.xarray.dev/en/stable/objects.inv
            - https://matplotlib.org/stable/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://python-markdown.github.io/objects.inv
            - https://scipy.github.io/devdocs/objects.inv
            - https://typing.readthedocs.io/en/latest/objects.inv
            - https://www.mkdocs.org/objects.inv
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: table
            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
  - footnotes
  - toc:
        permalink: true
  - pymdownx.emoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.magiclink
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences

hooks:
  - docs/hooks.py

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/flaport