NDSL/mkdocs.yml at develop · CharlesKrop/NDSL · 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
site_name: NDSL Documentation

theme:
  name: material
  features:
    - search.suggest
    - search.highlight
    - search.share

nav:
  - Home: index.md
  - User documentation: user/index.md
  - Porting:
    - General Concepts: porting/index.md
    - Testing Infrastructure: porting/translate/index.md
  - Under the hood:
    - Technical Documentation: dev/index.md
    - DaCe: dev/dace.md
    - GT4Py: dev/gt4py.md


markdown_extensions:
  # simple glossary file
  - abbr
  # support for colored notes / warnings / tips / examples
  - admonition
  # support for footnotes
  - footnotes
  # support for syntax highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      auto_append:
        # hover tooltips for abbreviations (simple glossary)
        - docs/includes/glossary.md
  - pymdownx.superfences:
      custom_fences:
      # support for mermaid graphs
      - name: mermaid
        class: mermaid
        format: python/name:pymdownx.superfences.fence_code_format
  # image inclusion

plugins:
  # add search box to the header, configuration in theme
  - search

watch:
  # reload when the glossary file is updated
  - docs/includes