vector/mkdocs.yml at main · goessl/vector · 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
site_name: vector
site_url: https://goessl.github.io/vector/
site_author: Sebastian Gössl
site_description: An infinite-dimensional vector Python package.

repo_name: goessl/vector
repo_url: https://github.com/goessl/vector

copyright: Copyright &copy; 2022 - 2025 Sebastian Gössl

nav:
  - Home: index.md
  - dense.md
  - lazy.md
  - inplace.md
  - sparse.md
  - parallelised.md
  - multilinear.md
  - multilinear_sparse.md
  - util.md

theme:
  name: material
  features:
    - navigation.footer
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to system preference

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/goessl/
      name: goessl on Github
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/lordgoessl/
      name: goessl on Instagram

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            members_order: source
            show_labels: false
            show_root_toc_entry: false
            show_symbol_type_heading: true
            group_by_category: false
            docstring_style: numpy

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true

extra_javascript:
  - mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/complexity.css
  - stylesheets/see-also.css
  - stylesheets/references.css