metaconf/mkdocs.yml at develop · jmarshrossney/metaconf · 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
site_name: metaconf
site_description: Documentation for the `metaconf` Python package.
site_url: https://jmarshrossney.github.io/metaconf

repo_url: https://github.com/jmarshrossney/metaconf
repo_name: jmarshrossney/metaconf

# NOTE: we can switch this to `true` when we publish the docs, since it
# leads to nicer urls, but `false` means we can browse the docs locally
# by simply opening `index.html`, without `mkdocs serve`.
use_directory_urls: true

theme:
  name: material
  features:
    - content.code.annotate  # allow code annotations
    - navigation.sections  # include sections in left navigation
    - toc.integrate  # toc integrated into left navigation
  palette:
    - scheme: default
      primary: indigo
      accent: green
      toggle:
        icon: material/brightness-3
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.caret  # Superscipt using ^x^
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde  # Subscript using ~x~
  - pymdownx.superfences
  - toc:
      permalink: "⚓"
      toc_depth: 3

plugins:
  - autorefs
  - include_exclude_files:
      exclude:
        - examples/101/.ipynb_checkpoints
        - examples/101/notebook.md
        - examples/jules/.ipynb_checkpoints
        - examples/jules/notebook.md
  - include-markdown
  - ipynb
  - markdown-exec
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            annotations_path: brief
            docstring_style: google
            docstring_section_style: list
            members_order: alphabetical
            line_length: 88
            separate_signature: true
            show_signature: true
            signature_crossrefs: true
            show_signature_annotations: true
            show_if_no_docstring: false
            show_root_full_path: true
            show_root_heading: true
            show_root_members_full_path: false
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
          paths: [src]
  - search

nav:
  - index.md
  - examples/101/notebook.ipynb
  - api.md
  - examples:
    - JULES land surface model: examples/jules/notebook.ipynb