pyrception/mkdocs.yml at dev · cantordust/pyrception · 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
site_name: Pyrception
repo_url: https://github.com/cantordust/pyrception
site_dir: site
docs_dir: docs
nav:
  - Overview: index.md
  - API:
      - Modules:
          - Visual:
              - Layers:
                  - Base: source/visual/layers/base.md
                  - Receptor: source/visual/layers/receptor.md
                  - Horizontal: source/visual/layers/horizontal.md
                  - Bipolar: source/visual/layers/bipolar.md
                  - Amacrine: source/visual/layers/amacrine.md
                  - Ganglion: source/visual/layers/ganglion.md
              - Kernel: source/visual/kernel.md
              - Receptive fields: source/visual/rf.md
              - Retina: source/visual/retina.md
      - Utilities:
          - Functions: source/utils/functions.md
          - Mixins: source/utils/mixins.md
          - Processors: source/utils/processors.md
          - Logging: source/utils/plotting.md
          - Logging: source/utils/logging.md
          - Enums: source/utils/enums.md
      - Configuration: source/config.md
  - Examples:
      - Image: notebooks/image.ipynb
      - Video: notebooks/video.ipynb
theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: blue grey
      accent: cyan
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: blue grey
      accent: cyan
  features:
    - navigation.instant
    - navigation.footer
    - navigation.path
    - content.code.select
    - content.code.copy
    - content.tabs.link
  font:
    text: Roboto
    code: Roboto Mono
  locale: en
  highlightjs: true
  color_mode: auto
  user_color_mode_toggle: true
  nav_style: dark
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [..]
          options:
            show_source: false
            group_by_category: false
            relative_crossrefs: true
  - mkdocs-jupyter:
      execute: false
      ignore_h1_titles: true
      include_source: true
  - macros:
      on_undefined: strict
      render_by_default: true
      include_dir: "./"
extra:
  version:
    provider: mike
extra_css:
  - stylesheets/extra.css
markdown_extensions:
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition