tapestry/mkdocs.yml at main · ACCIDDA/tapestry · 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
site_name: Tapestry
site_url: https://accidda.github.io/tapestry/
repo_url: https://github.com/ACCIDDA/tapestry
site_description: Probabilistic epidemic nowcasting and forecasting
docs_dir: docs

extra_css:
  - stylesheets/tapestry.css

extra_javascript:
  - javascripts/explorer-link.js

theme:
  name: material
  features:
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - toc.follow

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

markdown_extensions:
  - md_in_html
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

hooks:
  - scripts/docs_hooks.py

nav:
  - Intro: index.md
  - Architecture / reflection: architecture.md
  - Workflow:
      - Workflow: workflow.md
      - Setup: setup.md
  - Experiments:
      - Model runs: experiments/index.md
  - Data:
      - Overview: data/index.md
      - Interactive staircase: data/staircase.md
      - Revision explorer: data/revision-staircase.md
      - Sources: data/sources.md
      - Selection and provenance: data/methods.md
      - Panel diagnostics: data/panel.md
      - Explorer: explorer/overview.md
      - Explorer filters: explorer/filters.md
  - Reference:
      - Commands: reference/cli.md
      - Scenario fields: reference/scenario.md
      - Python API: reference/python-api.md
      - Other models: reference/other-models.md
      - FluSight model review: reference/flusight-2025-2026-model-review.md
      - Explorer API: explorer/api.md
      - Development: development.md