Skip to content

Commit e972374

Browse files
committed
docs
1 parent 83f86d1 commit e972374

File tree

4 files changed

+10
-23
lines changed

4 files changed

+10
-23
lines changed

README.rst

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Introduction
2121
:target: https://github.com/psf/black
2222
:alt: Code Style: Black
2323

24-
Touchscreen driver for the FT5336 touch controller
24+
CircuitPython driver for the FT5336 touch controller
2525

2626

2727
Dependencies
@@ -38,19 +38,10 @@ This is easily achieved by downloading
3838
or individual libraries can be installed using
3939
`circup <https://github.com/adafruit/circup>`_.
4040

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-
4641
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5846>`_
4742

4843
Installing from PyPI
4944
=====================
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.
5445

5546
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
5647
PyPI <https://pypi.org/project/adafruit-circuitpython-ft5336/>`_.
@@ -101,8 +92,7 @@ Or the following command to update an existing version:
10192
Usage Example
10293
=============
10394

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
10696
10797
Documentation
10898
=============

docs/conf.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@
2323
"sphinx.ext.todo",
2424
]
2525

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+
]
3132

3233
autodoc_preserve_defaults = True
3334

docs/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ Table of Contents
2424
.. toctree::
2525
:caption: Tutorials
2626

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>
2928

3029
.. toctree::
3130
:caption: Related Products
3231

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>
3533

3634
.. toctree::
3735
:caption: Other Links

requirements.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
21
# SPDX-FileCopyrightText: Copyright (c) 2023 Liz Clark for Adafruit Industries
32
#
43
# SPDX-License-Identifier: MIT
54

65
Adafruit-Blinka
76
adafruit-circuitpython-busdevice
87
adafruit-circuitpython-register
9-
n

0 commit comments

Comments
 (0)