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

theme:
  name: material
  palette:
    scheme: slate
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            inherited_members: false
            filters:
              - "!^_"
              - "^__init__"

nav:
  - Home: index.md
  - Guide:
      - Design Guide: design_guide.md
      - Philosophy: philosophy.md
      - Mathematics: mathematical.md
      - Innovations: innovations.md
      - Tutorial: tutorial.md
      - FAQ: faq.md
  - API Reference:
      - Core: api/core.md
      - Layers: api/layers.md
      - Functional: api/functional.md
      - Optimizers: api/optimizers.md
  - Project:
      - Roadmap: milestone.md

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true