mccode-antlr/mkdocs.yml at main · mccode-dev/mccode-antlr · 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
site_name: mccode-antlr
site_description: ANTLR4-based McStas and McXtrace instrument compiler and Python API
site_url: https://mccode-dev.github.io/mccode-antlr/
repo_url: https://github.com/mccode-dev/mccode-antlr
repo_name: mccode-dev/mccode-antlr
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.tabs.link

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            members_order: source
  - mkdocs-jupyter:
      execute: false
      include_source: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation & Quick Start: getting-started.md
    - Core Concepts: core-concepts.md
  - How-To Guides:
    - how-to/assembler-instrument.md
    - how-to/registry-components.md
    - how-to/compile-and-run.md
  - API Reference:
    - Assembler: api/assembler.md
    - Instrument (Instr): api/instr.md
    - Simulation: api/simulation.md
    - Registries: api/registry.md
    - Expressions: api/expression.md
    - Display geometry: api/display.md
    - CLI commands: api/cli.md
  - Jupyter Examples:
    - HTML Representation: examples/html-repr.ipynb