STUF/mkdocs.yml at main · CahanLab/STUF · 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
site_name: STUF
site_author: Patrick Cahan
copyright: Copyright &copy; 2025 Patrick Cahan
repo_url: https://github.com/CahanLab/STUF

use_directory_urls: false

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

theme:
  name: material
  font:
    text: Noto Sans
  palette:
    primary: blue grey
  logo: img/logoGlow.png
  favicon: img/logo.png
  features:
    - content.footnote.tooltips
    - navigation.expand
    - toc.integrate
#    - navigation.tabs
#    - navigation.tabs.sticky
#    - navigation.sections

markdown_extensions:
  - md_in_html
  - footnotes
  - admonition
  - attr_list
  - tables
  - def_list
  - toc:
      title: On this page
  - pymdownx.blocks.caption
  - pymdownx.tasklist:
      custom_checkbox: false
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            separate_signature: true
            docstring_section_style: list
            heading_level: 3
  - search
  - mkdocs-jupyter:
      execute: false
      include_source: True

nav:
  - Installation: install.md
  - Tutorials:
    - 'Quickstart': notebooks/quickstart.ipynb
#    - 'Plotting': notebooks/plotting.ipynb
#    - 'Tools': notebooks/tools.ipynb
  - Example data: example_data.md
  - API:
    - 'Utilities': 'utils.md'
    - 'Tools': 'tools.md'
    - 'Plots': 'plotting.md'