fdtdx/mkdocs.yml at main · rapradono/fdtdx · 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
site_name: FDTDX
repo_url: https://github.com/ymahlau/fdtdx
site_url: https://ymahlau.github.io/fdtdx
site_description: A JAX framework for the finite-difference time-domain (FDTD) method for solving Maxwell's equations with a focus on inverse design of photonic devices.
site_author: Yannik Mahlau and Frederik Schubert
edit_uri: edit/main/docs/
repo_name: ymahlau/fdtdx
copyright: Maintained by Yannik Mahlau

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_signature: true
            show_signature_annotations: true
            separate_signature: true
            show_bases: true
            merge_init_into_class: true
            # inherited_members: true
            group_by_category: true
            show_category_heading: false
            docstring_style: google
            show_root_heading: true
            show_root_toc_entry: false
  - mkdocs-jupyter:
      execute: false
      include: ["docs/notebooks/*.ipynb"]
      include_source: true
      include_requirejs: true
  - awesome-nav

theme:
  name: readthedocs
  custom_dir: docs/overrides
  logo: img/logo.png

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - codehilite:
      guess_lang: false
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences

# necessary for latex in docstrings
extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js