MRSimTracks/mkdocs.yml at main · mcgrathcm/MRSimTracks · 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
site_name: MRSimTracks
site_description: Generate CFD-derived particle trajectories for MR flow simulation.
site_url: https://mcgrathcm.github.io/MRSimTracks/
repo_url: https://github.com/mcgrathcm/MRSimTracks
repo_name: mcgrathcm/MRSimTracks

theme:
  name: material
  features:
    - navigation.sections
    - navigation.indexes
    - content.code.copy
    - content.code.annotate

nav:
  - Overview: index.md
  - Install: install.md
  - Quick Start: quickstart.md
  - Data Model: data-model.md
  - Reseeding: reseeding.md
  - API Reference: api.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - toc:
      permalink: true