emodpy-workflow/mkdocs.yml at main · EMOD-Hub/emodpy-workflow · 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
site_name: emodpy-workflow
site_url: https://emod.idmod.org/emodpy-workflow/
repo_name: EMOD-Hub/emodpy-workflow
repo_url: https://github.com/EMOD-Hub/emodpy-workflow/

theme:
  name: material
  custom_dir: docs/customization/overrides
  font:
    text: Roboto
    code: Roboto Mono
  logo: images/EMOD_logo.png
  favicon: images/favicon.ico
  features:
    - content.code.copy
    # - navigation.footer
  palette:
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Light mode
      primary: white
      accent: light blue
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Dark mode
      primary: black
      accent: light blue

nav:
  - Home: index.md
  - installation.md
  - Reference:
    - reference/virtual_environments.md
    - reference/commands.md
    - reference/projects.md
    - reference/frames.md
    - reference/sweeps.md
    - reference/dtktools_comparison.md
    - reference/age_bin_format.md
    - reference/ingest_form.md
  - How-to:
    - how_to/how_to_make_project.md
    - how_to/how_to_create_frame.md
    - how_to/how_to_use_elements_in_frame.md
    - how_to/how_to_list_hyperparameters.md
    - how_to/how_to_run.md
    - how_to/how_to_calibrate_frame.md
    - how_to/how_to_sweep.md
    - how_to/how_to_download_data.md
    - how_to/how_to_ingest_form.md
    - how_to/how_to_publish_new_country_model.md
  - Tutorials: # this creates a section in the TOC
    - tutorials/get_started.md
    - tutorials/setup.md
    - tutorials/create_project.md
    - tutorials/run_emod.md
    - tutorials/modify_reports.md
    - tutorials/modify_configuration.md
    - tutorials/modify_campaign_1_minimal_campaign.md
    - tutorials/modify_campaign_2_add_vaccine.md
    - tutorials/modify_campaign_3_modify_country_model.md
    - tutorials/use_parameterized_calls.md
    - tutorials/sweep_parameter.md
    - tutorials/run_calibration.md
  - Related projects: https://emod.idmod.org/

plugins:
  - search:
  - autorefs:
  - include-markdown:
  - glightbox:
  - table-reader:
  - mkdocs-jupyter:  # enables Jupyter notebooks to be rendered
      execute: true
      allow_errors: false  # set to true to continue executing cells even if one fails
      include_source: true
  - mkdocstrings:

markdown_extensions:
  - admonition:
  - attr_list:  # enables HTMl and CSS classes to inline elements
  - def_list:
  - footnotes:
  - toc:
      toc_depth: 3
  - md_in_html:  # enables grids
  - pymdownx.arithmatex:  # Latex processing for math equations
      generic: true
  - pymdownx.blocks.caption:  # captions for images, tables, etc.
  - pymdownx.blocks.details:  # allows nesting of collapsible code
  - pymdownx.caret:  # superscripts
  - pymdownx.details:  # collapsible elements
  - pymdownx.emoji:  # emojis and icons
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:  # syntax highlighting for code blocks
      linenums: true  # adds line numbers to code blocks automatically
      anchor_linenums: true  # adds HTML anchors (#L1, #L2, etc.) to each line so you can link to specific ones.
      default_lang: 'python'
  - pymdownx.inlinehilite:  # syntax highlighting for inline code
  - pymdownx.mark:  # text highlighting
  - pymdownx.snippets:  # snippet reuse functionality
      auto_append:
        - docs/bib.md
  - pymdownx.superfences:  # enables code, diagram fences to be nested in lists, etc.e
  - pymdownx.tabbed: # tabbed content that can be toggled
      alternate_style: true
  - pymdownx.tilde:  # subscripts

copyright: Copyright &copy; 2025 Gates Foundation. All rights reserved.

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - customization/css/extra.css

extra:
  generator: false  # Removes acknowledgement of mkdocs-material
  footer_links:
    - text: "Privacy and Cookies Notice"
      href: "https://www.gatesfoundation.org/Privacy-and-Cookies-Notice"
    - text: "Terms of Use"
      href: "https://www.gatesfoundation.org/Terms-of-Use"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EMOD-Hub/
    - icon: octicons/comment-discussion-24
      link: https://github.com/EMOD-Hub/issues-and-discussions
    - icon: octicons/globe-24
      link: https://idmod.org
    - icon: simple/youtube
      link: http://www.youtube.com/@institutefordiseasemodelin1987
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/institute-disease-modeling
  analytics:
    provider: custom
    property: GTM-NK4K647
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback! If you like, provide additional information by
            using our <a href="https://app.smartsheet.com/b/form/ec8dbb77809949ecab7286a5ca74a206" target="_blank" rel="noopener">feedback form</a>.
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://app.smartsheet.com/b/form/ec8dbb77809949ecab7286a5ca74a206" target="_blank" rel="noopener">feedback form</a>.