sparse-pixels/mkdocs.yml at main · hftsoi/sparse-pixels · 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
site_name: SparsePixels
site_url: https://hftsoi.github.io/sparse-pixels
repo_url: https://github.com/hftsoi/sparse-pixels
repo_name: hftsoi/sparse-pixels

extra_css:
  - style.css

theme:
  name: material
  logo: figs/logo.png
  favicon: figs/logo.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight

nav:
  - Home: index.md
  - Overview: overview.md
  - Installation: install.md
  - Quick Start: quick_start.md
  - Training & Monitoring: training.md
  - HLS Conversion: conversion.md
  - API Reference: api.md
  - Sparse MNIST Demo: demo/notebooks/sparse_mnist.ipynb
  - Citation: citation.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - table-reader
  - mkdocs-jupyter:
      include_source: true
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_root_heading: true
            show_root_full_path: false
            heading_level: 3
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            members_order: source