patchsim/mkdocs.yml at main · dsih-artpark/patchsim · 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

site_name: Compartmental Multi-Patch Simulation Framework
site_description: Documentation for a modular metapopulation simulation framework for multi-disease epidemiological modelling.
site_author: Shreya Mukherjee
repo_url: https://github.com/dsih-artpark/patchsim
repo_name: GitHub

theme:
  name: material
  palette:
    # Light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # 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.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: ["src"]
          options:
            docstring_style: google
            show_source: true

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

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Configuration: configuration.md
  - Architecture: architecture.md
  - Mathematical Model: mathematical-model.md
  - Simulation Workflow: simulation-workflow.md
  - Network Design: network-design.md
  - Results: results.md
  - References:
      - Core: reference/core.md
      - Models: reference/models.md
      - Utils: reference/utils.md
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dsih-artpark/patchsim