cosecha/mkdocs.yml at main · Dewberry/cosecha · 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
site_name: Cosecha
site_url: https://dewberry.github.io/cosecha/

theme:
  name: materialx
  custom_dir: docs/overrides
  font:
    text: Red Hat Text
    code: JetBrains Mono

  palette:
    # Palette toggle for automatic mode
  - media: (prefers-color-scheme)
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode

    # Palette toggle for light mode
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: deep purple
    accent: deep purple
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode

    # Palette toggle for dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: blue grey
    accent: blue grey
    toggle:
      icon: material/brightness-4
      name: Switch to system preference

  icon:
    edit: material/pencil
    view: material/eye

  features:
  - content.tabs.link
  - content.code.copy
  - content.action.edit
  - content.code.annotate
  - navigation.sections
  - navigation.expand
  - navigation.collapse
  - navigation.instant
  - navigation.instant.progress
  - navigation.tracking
  - navigation.top
  - navigation.footer
  - navigation.indexes
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.path
  - search.suggest
  - search.highlight
  - toc.follow
  - toc.integrate

repo_url: https://github.com/dewberry/cosecha/
edit_uri: edit/main/docs/

markdown_extensions:
- attr_list
- md_in_html
- admonition
- def_list
- footnotes
- pymdownx.tasklist:
    custom_checkbox: true
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.details
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
- pymdownx.tabbed:
    alternate_style: true
- toc:
    toc_depth: 3
    permalink: '#'

extra:
  homepage: https://dewberry.github.io/cosecha/
  version:
    provider: mike
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/dewberry

nav:
- Getting Started: README.md
- Examples:
  - Overview: examples/index.md
  - Hurricane Beryl Flood Analysis: examples/beryl_flood_analysis.ipynb
- API Reference: reference.md
- Release Notes: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
plugins:
- search
- mkdocs-jupyter:
    include: ['*.ipynb']
    include_source: true
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        inventories:
        - https://docs.python.org/3/objects.inv
        paths: [src]
        options:
          docstring_style: numpy
          inherited_members: true
          members_order: source
          separate_signature: true
          unwrap_annotated: false
          filters:
          - '!^_'
          merge_init_into_class: true
          docstring_section_style: list
          signature_crossrefs: true
          show_source: false
hooks:
- docs/docs_hooks.py

extra_css:
- stylesheets/extra.css