EpiBenchmark/mkdocs.yml at main · ACCIDDA/EpiBenchmark · 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
site_name: EpiBenchmark
site_description: User-facing documentation for the EpiBenchmark Python package.
site_url: https://accidda.github.io/EpiBenchmark/
repo_url: https://github.com/ACCIDDA/EpiBenchmark
repo_name: ACCIDDA/EpiBench
exclude_docs: |
  design.md
  api/

theme:
  name: material
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    scheme: default
    primary: green
    accent: amber
  features:
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: ["src"]
          options:
            show_root_heading: true
            show_source: false
            show_signature_annotations: true
            members_order: source

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Installation (for longleaf): getting-started/installation_longleaf.md
      - Overview: getting-started/overview.md
      - Configuration templates: getting-started/configuration-templates.md
  - Challenge Information:
    - Challenge library: challenge-information/challenges.md
    - Participating in a challenge: challenge-information/challenge-participation.md
  - Commands:
      - epibench list: commands/epibench-list.md
      - epibench fetch: commands/epibench-fetch.md
      - epibench create: commands/epibench-create.md
      - epibench score: commands/epibench-score.md
      - epibench plot: commands/epibench-plot.md
  - API reference: reference.md
  # - API Reference:
  #     - Overview: api/index.md
  #     - epibench.__init__: api/__init__.md
  #     - epibench.__main__: api/__main__.md
  #     - epibench.benchmark_plotting: api/benchmark_plotting.md
  #     - epibench.cli: api/cli.md
  #     - epibench.config: api/config.md
  #     - epibench.extract_model_data_details: api/extract_model_data_details.md
  #     - epibench.ground_truth: api/ground_truth.md
  #     - epibench.gt_from_hub: api/gt_from_hub.md
  #     - epibench.plot_evaluation_results: api/plot_evaluation_results.md
  #     - epibench.score: api/score.md
  #     - epibench.scoring_logic: api/scoring_logic.md
  #     - epibench.create: api/create.md