pytorch-lightning-template/mkdocs.yml at master · insane-group/pytorch-lightning-template · 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
site_name: Pytorch Lightning Template
site_description: "Generic template to bootstrap your PyTorch project"
site_url: "https://insane-group.github.io/pytorch-lightning-template"
repo_url: "https://github.com/insane-group/pytorch-lightning-template"
edit_uri: "edit/master/docs/"
repo_name: "insane-group/pytorch-lightning-template"
copyright: |
  Copyright &copy; 2024 <a href="https://github.com/orgs/insane-group" target="_blank" rel="noopener">INSANE Group</a>
nav:
  - Overview: index.md
  - Getting Started:
      - Welcome to MkDocs: welcome.md
  - Code Reference:
      - Model: code/models/mnist.md
  - Contributing:
      - Contributing Guidelines: CONTRIBUTING.md
      - Code Of Conduct: CODE_OF_CONDUCT.md
      - License: LICENSE.md
theme:
  name: material
  features:
    - search.suggest
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.instant
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/lightbulb-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
plugins:
  - search
  - social
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: yes
            merge_init_into_class: yes
            show_submodules: no
            show_root_toc_entry: no
            show_symbol_type_toc: true
            show_symbol_type_heading: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            show_source: true
            modernize_annotations: true
            summary: true
  - minify:
      minify_html: true
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - toc:
      permalink: ¤
  - mdx_truly_sane_lists
watch:
  - src
  - docs
  - README.md
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/insane-group
    - icon: fontawesome/solid/envelope
      link: mailto:insane@iit.demokritos.gr
    - icon: fontawesome/solid/globe
      link: https://insane.iit.demokritos.gr
  version:
    provider: mike
extra_css:
  - css/mkdocsoad.css