mmgpy/mkdocs.yml at main · kmarchais/mmgpy · 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
site_name: mmgpy
site_description: Python bindings for the MMG remeshing library
# mike overrides site_url per version during deploy; this is the base for local builds
site_url: https://kmarchais.github.io/mmgpy
repo_url: https://github.com/kmarchais/mmgpy
repo_name: kmarchais/mmgpy
# NOTE: always points to main branch — "Edit" links on older versioned docs
# may reference files that have since changed or moved
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2024-2026 Kevin Marchais

theme:
  name: material
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep-orange
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mike:
      alias_type: symlink
      canonical_version: latest
      redirect_template: null
      deploy_prefix: ""
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: list
            show_root_heading: true
            show_source: false
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            line_length: 88
            members_order: source
            show_symbol_type_heading: true
            show_symbol_type_toc: true

extra_css:
  - assets/css/blender-extension-stats.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Core Concepts: getting-started/concepts.md
  - Tutorials:
      - Basic Remeshing: tutorials/basic-remeshing.md
      - Surface Remeshing: tutorials/surface-remeshing.md
      - Adaptive Sizing: tutorials/adaptive-sizing.md
      - Hessian-Based Adaptation: tutorials/hessian-adaptation.md
      - Elasticity Propagation: tutorials/elasticity-propagation.md
      - PyVista Integration: tutorials/pyvista-integration.md
      - Level-Set Extraction: tutorials/levelset-extraction.md
  - Examples:
      - Gallery: examples/index.md
  - API Reference:
      - Overview: api/index.md
      - Mesh Classes: api/mesh-classes.md
      - Options: api/options.md
      - Results & Validation: api/results-validation.md
      - Sizing Constraints: api/sizing.md
      - Metrics: api/metrics.md
      - I/O Functions: api/io.md
      - Lagrangian Motion: api/lagrangian.md
  - Reference:
      - CLI Tools: reference/cli.md
      - File Formats: reference/file-formats.md
      - MMG Parameters: reference/mmg-parameters.md
      - API Coverage: reference/mmg-api-coverage.md
      - Benchmarks: reference/benchmarks.md
  - Blender Extension: blender-extension.md
  - Changelog: changelog.md

extra_javascript:
  - https://cdn.jsdelivr.net/npm/chart.js@4.4.8/dist/chart.umd.min.js
  - assets/js/benchmarks.js
  - assets/js/blender-extension-stats.js

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/kmarchais/mmgpy
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/mmgpy/