spear/mkdocs.yml at main · RadicalNumerics/spear · 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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
site_name: SPEAR
site_url: https://radical/spear/
repo_name: RadicalNumerics/spear
repo_url: https://github.com/RadicalNumerics/spear/
edit_uri: edit/main/docs
site_description: Official documentation for SPEAR
copyright: Made by <a href="https://radicalnumerics.ai">Radical Numerics ⠏⠆</a>
docs_dir: .

nav:
  - Home: docs/index.md # NOTE: this gets generated by the hooks.py script by prepending the fancy-first-page.txt to README.md
  - Concepts:
    - Sliding Window Recurrences: docs/concepts/swr.md
    - Block Two-Pass: docs/concepts/btp.md
    - Phalanx Layer: docs/concepts/phalanx.md
  - API Reference:
    - Overview: docs/api/index.md
    - Nets: docs/api/nn.md
    - Operations: docs/api/ops.md
  - Examples:
    - Stability: examples/test_stability_log_space.ipynb

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/radicalnumerics
  - icon: fontawesome/solid/globe
    link: https://radicalnumerics.ai

theme:
  name: material
  logo: https://raw.githubusercontent.com/RadicalNumerics/assets/refs/heads/main/svg/favicon.svg
  favicon: https://raw.githubusercontent.com/RadicalNumerics/assets/refs/heads/main/svg/favicon.svg
  primary: red
  features:
    - announce.dismiss
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.indexes
    - navigation.path
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.tabs # horizontal tabs for navigation
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font: false  # Disable default fonts to use custom Geist fonts

extra_css:
  - docs/stylesheets/extra.css # Our custom CSS
  - docs/stylesheets/mkdocstrings.css # mkdocstrings CSS
  - https://unpkg.com/katex@0/dist/katex.min.css # Latex math rendering

extra_javascript:
  - docs/js/katex.js # Latex math rendering
  - https://unpkg.com/katex@0/dist/katex.min.js # Latex math rendering
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js # Latex math rendering

extra:
  version:
    default: stable

plugins:
  - mkdocstrings:
      enable_inventory: true # create .inv file for auto linking
      handlers:
        python:
          paths: [spear]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_signature_annotations: true
            docstring_section_style: list
            heading_level: 2
            inherited_members: false
            show_root_heading: true
            show_root_toc_entry: false
            show_root_full_path: false
            show_source: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            extensions:
            - griffe_inherited_docstrings
          import:
            - https://docs.python.org/3/objects.inv
  - mike:
      alias_type: symlink
      canonical_version: latest
  - mkdocs-jupyter:
      include_source: True
      include: ["*ipynb"]
  - search
  - autorefs
  - autolinks
  - same-dir

hooks:
  - docs/hooks.py

markdown_extensions:
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.magiclink
  - pymdownx.superfences
  - tables
  - toc:
      permalink: true
      title: Page contents
  - admonition
  - pymdownx.extra
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - def_list
  - mdx_truly_sane_lists
  - mdx_breakless_lists
  - gfm_admonition