site_name: GOAD
nav:
- index.md
- settings.md
- results.md
- checks.md
- convergence.md
- api.md
- Examples:
- examples/backscattering.md
site_url: https://hballington12.github.io/goad/
repo_url: https://github.com/hballington12/goad
repo_name: Github
site_author: Harry Ballington
site_description: GOAD is a Rust/Python library for simulating geometric optics with aperture diffraction.
plugins:
- search
- macros:
module_name: docs/source/_build/scripts/macro
- mkdocstrings:
handlers:
python:
options:
show_source: false
show_bases: false
inherited_members: false
show_if_no_docstring: false
show_signature_annotations: true
separate_signature: true
signature_crossrefs: true
merge_init_into_class: true
docstring_style: google
members_order: source
filters:
- "!^__module__$"
- "!^__doc__$"
- "!^__dict__$"
- "!^__weakref__$"
theme:
logo: img/favicon.png
name: material
locale: en
favicon: img/favicon.ico
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tracking
- navigation.sections
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
- navigation.indexes
- content.tabs.link
- content.code.copy
icon:
repo: fontawesome/brands/github
markdown_extensions:
- pymdownx.snippets:
base_path: ["docs/source/src"]
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg