CryoGrid-pyTools/mkdocs.yml at main · lukegre/CryoGrid-pyTools · 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
site_name: CryoGrid-pyTools
theme:
  icon:
    logo: material/snowflake
  name: material
  palette:
  - scheme: default
    primary: blue
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  # Palette toggle for dark mode
  - scheme: slate
    primary: blue
    toggle:
      icon: material/brightness-4
      name: Switch to light mode

repo_url: https://github.com/lukegre/CryoGrid-pyTools
repo_name: GitHub

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [cryogrid_pytools]
          options:
            heading_level: 3
            show_source: false
            show_signature: false
            show_root_heading: true
            docstring_style: numpy

nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started: getting-started.md
  - Usage:
    - Reading CryoGrid Output: usage/reading-output.md
    - Reading MATLAB Structs: usage/reading-matlab.md
    - Mapping clustered runs: usage/mapping-clustered-runs.md
    - Working with Forcing Data: usage/forcing.md
    - Spatial Data and Forcing: usage/forcing-spatial.md
  - API Reference: api-reference.md