diffWOFOST/mkdocs.yml at main · WUR-AI/diffWOFOST · 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
site_name: diffWOFOST documentation
repo_url: https://github.com/WUR-AI/diffwofost
repo_name: diffWOFOST

nav:
  - Introduction:
    - diffWOFOST: index.md
    - Citation: citation.md
    - License: license.md
    - Acknowledgements: acknowledgements.md
    - References: references.md
  - Getting started:
    - Installation: installation.md
    - How to run a model: run_model.md
    - Example notebooks: examples.md
  - How to Contribute:
    - Contributing guide: CONTRIBUTING.md
    - Developer guide: developer_guide.md
  - API Reference: api_reference.md

theme:
  name: material
  custom_dir: docs/download_button
  logo: logo/diffwofost.png
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy
    - content.tabs
  icon:
    repo: fontawesome/brands/github-alt

  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: green
      accent: blue

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: green
      accent: teal

plugins:
- include-markdown
- search
- mkdocs-jupyter:
      include_source: True
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          docstring_style: google
          docstring_options:
            ignore_init_summary: true
          merge_init_into_class: true
          docstring_section_style: list
          show_submodules: true
          show_root_heading: true
          show_source: true
          heading_level: 3
          relative_crossrefs: true
          parameter_headings: false
          separate_signature: true
          show_bases: true
          show_signature_annotations: true
          show_symbol_type_heading: true
          signature_crossrefs: true
          summary: true
          backlinks: tree
          scoped_crossrefs: true
          members_order: source

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.emoji
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  -  attr_list

extra:
  generator: false
  math: mathjax

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js