compas_gmsh/mkdocs.yml at main · compas-dev/compas_gmsh · 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
143
144
145
146
147
site_name: COMPAS GMSH
site_url: https://github.com/compas-dev/compas_gmsh/

repo_name: compas-dev/compas_gmsh
repo_url: https://github.com/compas-dev/compas_gmsh/

copyright: Copyright &copy; ETH Zurich - Block Research Group

extra:
  homepage: https://compas-dev.github.io/compas_gmsh/
  version:
    provider: mike

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  logo: assets/logos/compas_icon_white.png
  favicon: public/favicon.ico
  features:
    - content.code.copy
    - content.footnote.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow

markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - callouts:
      strip_period: no
  - footnotes
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - toc:
      permalink: "¤"

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src] # search packages in the src folder
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://compas.dev/compas/latest/objects.inv
          options:
            allow_inspection: true
            backlinks: tree
            docstring_options:
              ignore_init_summary: true
              trim_doctest_flags: true
            docstring_style: numpy
            docstring_section_style: list
            filters: public
            group_by_category: true
            heading_level: 1
            inheritance_diagram_direction: TD
            inherited_members: false
            line_length: 88
            merge_init_into_class: true
            modernize_annotations: true
            parameter_headings: false
            preload_modules: [mkdocstrings, compas]
            relative_crossrefs: true
            scoped_crossrefs: true
            separate_signature: true
            show_bases: false
            show_category_heading: true
            show_docstring_attributes: true
            show_docstring_functions: true
            show_docstring_modules: false
            show_if_no_docstring: false
            show_inheritance_diagram: false
            show_root_heading: true
            show_root_full_path: true
            show_signature: true
            show_signature_annotations: true
            show_signature_type_parameters: true
            show_source: false
            show_submodules: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary:
              modules: false
            type_parameter_headings: true
            unwrap_annotated: true

nav:
  - Introduction: index.md
  - Installation: installation.md
  - Tutorial: tutorial.md
  - API:
      - Models:
          - Model: api/compas_gmsh.models.Model.md
          - MeshModel: api/compas_gmsh.models.MeshModel.md
          - ShapeModel: api/compas_gmsh.models.ShapeModel.md
          - CSGModel: api/compas_gmsh.models.CSGModel.md
  - Other:
      - License: license.md
      - Acknowledgements: acknowledgements.md
      - changelog.md