KuttyPy-GUI/mkdocs.yml at master · csparkresearch/KuttyPy-GUI · 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
125
126
site_name: KuttyPy Graphical Interface Documentation
theme:
  name: 'material'
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  logo: images/kuttypy.png
  favicon: 'images/favicon.png'
  features:
    - navigation.footer
    - content.code.copy
  icon:
    annotation: material/arrow-right-circle


#theme: 'readthedocs'
markdown_extensions:
    - toc:
        permalink: True
    - admonition
    - smarty
    - attr_list
    - wikilinks
    - codehilite:
        linenums: False
    - pymdownx.arithmatex
    - pymdownx.betterem:
        smart_enable: all
    - pymdownx.caret
    - pymdownx.critic
    - pymdownx.details
    - pymdownx.inlinehilite
    - pymdownx.magiclink
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.superfences:
       preserve_tabs: true
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.tasklist:
        custom_checkbox: True
    - pymdownx.tilde

extra_css: ["assets/main.css"]
site_favicon: 'images/favicon.ico'

extra:
  palette:
      primary: '#087da1'
      accent: '#00a889'
  generator: false
  social:
    - icon: fontawesome/brands/twitter
      link: https://x.com/csparkresearch
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/csparkresearch
    - icon: fontawesome/brands/github
      link: https://github.com/csparkresearch


plugins:
   - search
   - exclude-search:
      exclude:
        - workshopnano.md
        - boards.md
   - table-reader
   - material/social:
      cards: true
      cards_font: Roboto
   #- page-to-pdf


repo_name: 'csparkresearch/kuttypy-gui'
repo_url: 'https://github.com/csparkresearch/kuttypy-gui'
copyright: 'Copyright © 2019 <a href="https://csparkresearch.in">CSpark Research</a>'

google_analytics:
  - 'UA-67472997-4'
  - 'auto'

nav:
  - Home: 'index.md'
  - Getting Started:
      - 'Installation': 'installation.md'
      - 'Software': 'software.md'
  - I/O and Peripherals:
      - 'Basic I/O': 'io.md'
      - '8 Channel Voltmeter': 'adc.md'
      - 'Stepper Motors': 'stepper.md'
  - I2C Sensors: 'sensors.md'
  - Programming - Python:
      - 'Introduction': 'programming/intro.md'
      - 'Basic I/O': 'programming/basics.md'
      - 'I2C and Sensors': 'programming/i2c.md'
  - Programming - Visual: 'programming/visual.md'
  - Programming - C:
      - 'Introduction': 'programming/c.md'
      - 'What is the IDE': 'IDE.md'
      - 'BMP180 temperature': 'programming/BMP180.md'
      - 'MPU6050 accelerometer': 'programming/MPU6050.md'
      - 'PCF8574 I2C LCD Display': 'programming/I2C_LCD_PCF8574.md'
      - 'Time of Flight Measurement': 'programming/time_of_flight.md'

  - Projects:
      - 'R2R DAC Wavegen': 'programming/r2r_wavegen.md'
      - 'Optics: Malus Law': 'malus.md'
  - KuttyPy Hardware:
      - 'Design': 'hw.md'
      - 'Firmware': 'boot.md'
      - 'Enclosures': 'enclosures.md'
#  - Nano Tutorial: 'workshopnano.md'
  - 2 Hour Tutorial: 'workshop.md'
  - Beginner Workshop with Android: 'androidworkshop.md'
#  - Arduino Boards : 'boards.md'