Skip to content

Commit dbe21a7

Browse files
committed
fixed docs about examples; (+) pypi sidebar links
1 parent 6843f60 commit dbe21a7

File tree

4 files changed

+17
-12
lines changed

4 files changed

+17
-12
lines changed

docs/examples.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
Simple Test
22
-----------
33

4-
Ensure your device works with this simple test (using SPI protocol).
4+
Ensure your device works with this simple test.
55

6-
.. literalinclude:: ../examples/cirque_pinnacle_spi_simpletest.py
7-
:caption: examples/cirque_pinnacle_spi_simpletest.py
6+
.. literalinclude:: ../examples/cirque_pinnacle_simpletest.py
7+
:caption: examples/cirque_pinnacle_simpletest.py
88
:linenos:
99

1010
USB Mouse example
1111
-----------------
1212

1313
This example uses CircuitPython's built-in `usb_hid` API to emulate a mouse with the Cirque circle trackpad.
1414

15-
1615
.. literalinclude:: ../examples/cirque_pinnacle_usb_mouse.py
1716
:caption: examples/cirque_pinnacle_usb_mouse.py
1817
:linenos:
@@ -22,7 +21,6 @@ AnyMeas mode example
2221

2322
This example uses the Pinnacle touch controller's AnyMeas mode to fetch raw ADC values.
2423

25-
2624
.. literalinclude:: ../examples/cirque_pinnacle_anymeas_test.py
2725
:caption: examples/cirque_pinnacle_anymeas_test.py
2826
:linenos:

examples/cirque_pinnacle_simpletest.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""A simple test example. this example also works with glidepoint_lite.py"""
1+
"""A simple test example. This example also works with glidepoint_lite.py"""
22
import time
33
import struct
44
import board
@@ -9,11 +9,11 @@
99
# from circuitpython_cirque_pinnacle.glidepoint import PinnacleTouchI2C, ABSOLUTE, RELATIVE
1010
# i2c = board.I2C()
1111

12-
spi = board.SPI() # if using a trackpad configured for SPI
13-
ss_pin = DigitalInOut(board.D7)
1412
dr_pin = DigitalInOut(board.D2)
1513

1614
# if using a trackpad configured for SPI
15+
spi = board.SPI()
16+
ss_pin = DigitalInOut(board.D7)
1717
tpad = PinnacleTouchSPI(spi, ss_pin) # NOTE we did not pass the dr_pin
1818
# if using a trackpad configured for I2C
1919
# tpad = PinnacleTouchI2C(i2c) # NOTE we did not pass the dr_pin

examples/cirque_pinnacle_usb_mouse.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,11 @@
1111
# from circuitpython_cirque_pinnacle.glidepoint import PinnacleTouchI2C, RELATIVE
1212
# i2c = board.I2C()
1313

14-
# if using a trackpad configured for SPI
15-
spi = board.SPI()
16-
ss_pin = DigitalInOut(board.D7)
17-
1814
dr_pin = DigitalInOut(board.D2)
1915

2016
# if using a trackpad configured for SPI
17+
spi = board.SPI()
18+
ss_pin = DigitalInOut(board.D7)
2119
tpad = PinnacleTouchSPI(spi, ss_pin) # NOTE we did not pass the dr_pin
2220
# if using a trackpad configured for I2C
2321
# tpad = PinnacleTouchI2C(i2c) # NOTE we did not pass the dr_pin

setup.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,13 @@
6363
# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
6464
# CHANGE `py_modules=['...']` TO `packages=['...']`
6565
packages=['circuitpython_cirque_pinnacle'],
66+
67+
# Specifiy your homepage URL for your project here
68+
url=repo,
69+
70+
# Extra links for the sidebar on pypi
71+
project_urls={
72+
'Documentation': 'https://circuitpython-cirque-pinnacle.readthedocs.io',
73+
},
74+
download_url='{}/releases'.format(repo),
6675
)

0 commit comments

Comments
 (0)