gregor/mkdocs.yml at main · modelblocks-org/gregor · 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
site_name: Gregor
copyright: Copyright &copy; since 2024 (MIT licensed)
nav:
  - Getting started: index.md
  - Examples:
    - examples/disaggregate-to-raster.py
    - examples/disaggregate-to-point.py
    - Running via CLI: examples/cli.md
  - API documentation: api.md
  - Changelog: Changelog.md
theme:
  name: material
  logo: img/gregor.svg
  favicon: img/gregor_black.svg
  palette:
    primary: 'black'
    accent: 'black'
  font:
    text: 'Roboto'
    code: Source Code Pro
  features:
    - navigation.indexes
    - navigation.top
  navigation:
    tabs: false
    sections: false
plugins:
  - search
  - autorefs
  - mkdocs-jupyter:
      include: ["examples/*.py"]
      ignore: []
      allow_errors: false
      # kernel_name: calliope_docs_build
      include_source: True
      execute: true
      include_requirejs: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_bases: true
            filters:
              - "!^_"
            heading_level: 1
            show_root_heading: true
            merge_init_into_class: true
            show_if_no_docstring: true
            signature_crossrefs: true
            show_root_toc_entry: false
            show_signature_annotations: false
            inherited_members: true
            docstring_style: numpy
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://docs.xarray.dev/en/stable/objects.inv
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: "¶"

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      preserve_tabs: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde