meanas/mkdocs.yml

76 lines
1.6 KiB
YAML
Raw Normal View History

2026-04-18 15:05:35 -07:00
site_name: meanas
site_description: Electromagnetic simulation tools
2026-04-18 22:58:38 -07:00
site_url: !ENV [DOCS_SITE_URL, ""]
2026-04-18 15:05:35 -07:00
repo_url: https://mpxd.net/code/jan/meanas
repo_name: meanas
docs_dir: docs
site_dir: site
strict: false
theme:
name: material
font: false
features:
- navigation.indexes
- navigation.sections
- navigation.top
- content.code.copy
- toc.follow
nav:
- Home: index.md
- API:
- Overview: api/index.md
- meanas: api/meanas.md
- eigensolvers: api/eigensolvers.md
- fdfd: api/fdfd.md
- waveguides: api/waveguides.md
- fdtd: api/fdtd.md
- fdmath: api/fdmath.md
plugins:
- search
- mkdocstrings:
handlers:
python:
paths:
- !ENV [MKDOCSTRINGS_PYTHON_PATH, "."]
2026-04-18 15:05:35 -07:00
options:
show_root_heading: true
show_root_toc_entry: false
show_source: false
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
members_order: source
separate_signature: true
merge_init_into_class: true
docstring_style: google
- print-site
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
- assets/vendor/mathjax/startup.js
watch:
- meanas