File tree Expand file tree Collapse file tree 4 files changed +10
-23
lines changed Expand file tree Collapse file tree 4 files changed +10
-23
lines changed Original file line number Diff line number Diff line change @@ -21,7 +21,7 @@ Introduction
21
21
:target: https://github.com/psf/black
22
22
:alt: Code Style: Black
23
23
24
- Touchscreen driver for the FT5336 touch controller
24
+ CircuitPython driver for the FT5336 touch controller
25
25
26
26
27
27
Dependencies
@@ -38,19 +38,10 @@ This is easily achieved by downloading
38
38
or individual libraries can be installed using
39
39
`circup <https://github.com/adafruit/circup >`_.
40
40
41
-
42
-
43
- .. todo :: Describe the Adafruit product this library works with. For PCBs, you can also add the
44
- image from the assets folder in the PCB's GitHub repo.
45
-
46
41
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5846 >`_
47
42
48
43
Installing from PyPI
49
44
=====================
50
- .. note :: This library is not available on PyPI yet. Install documentation is included
51
- as a standard element. Stay tuned for PyPI availability!
52
-
53
- .. todo :: Remove the above note if PyPI version is/will be available at time of release.
54
45
55
46
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
56
47
PyPI <https://pypi.org/project/adafruit-circuitpython-ft5336/> `_.
@@ -101,8 +92,7 @@ Or the following command to update an existing version:
101
92
Usage Example
102
93
=============
103
94
104
- .. todo :: Add a quick, simple example. It and other examples should live in the
105
- examples folder and be included in docs/examples.rst.
95
+ .. code-block :: python
106
96
107
97
Documentation
108
98
=============
Original file line number Diff line number Diff line change 23
23
"sphinx.ext.todo" ,
24
24
]
25
25
26
- # TODO: Please Read!
27
- # Uncomment the below if you use native CircuitPython modules such as
28
- # digitalio, micropython and busio. List the modules you use. Without it, the
29
- # autodoc module docs will fail to generate with a warning.
30
- # autodoc_mock_imports = ["digitalio", "busio"]
26
+ autodoc_mock_imports = [
27
+ "micropython" ,
28
+ "busio" ,
29
+ "adafruit_bus_device" ,
30
+ "adafruit_register" ,
31
+ ]
31
32
32
33
autodoc_preserve_defaults = True
33
34
Original file line number Diff line number Diff line change @@ -24,14 +24,12 @@ Table of Contents
24
24
.. toctree ::
25
25
:caption: Tutorials
26
26
27
- .. todo :: Add any Learn guide links here. If there are none, then simply delete this todo and leave
28
- the toctree above for use later.
27
+ Adafruit 3.5" 320x480 Color TFT Touchscreen Breakout Learn Guide <https://learn.adafruit.com/adafruit-3-5-color-320x480-tft-touchscreen-breakout >
29
28
30
29
.. toctree ::
31
30
:caption: Related Products
32
31
33
- .. todo :: Add any product links here. If there are none, then simply delete this todo and leave
34
- the toctree above for use later.
32
+ Adafruit 3.5" TFT 320x480 with Capacitive Touch Breakout Board - EYESPI <https://www.adafruit.com/product/5846 >
35
33
36
34
.. toctree ::
37
35
:caption: Other Links
Original file line number Diff line number Diff line change 1
- # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
2
1
# SPDX-FileCopyrightText: Copyright (c) 2023 Liz Clark for Adafruit Industries
3
2
#
4
3
# SPDX-License-Identifier: MIT
5
4
6
5
Adafruit-Blinka
7
6
adafruit-circuitpython-busdevice
8
7
adafruit-circuitpython-register
9
- n
You can’t perform that action at this time.
0 commit comments