[docs] switch generated docs to MkDocs
This commit is contained in:
parent
5e95d66a7e
commit
a82eb5858a
54 changed files with 350 additions and 2000 deletions
76
mkdocs.yml
Normal file
76
mkdocs.yml
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
site_name: meanas
|
||||
site_description: Electromagnetic simulation tools
|
||||
site_url: ""
|
||||
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:
|
||||
- .
|
||||
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
|
||||
Loading…
Add table
Add a link
Reference in a new issue