Skip to content

Commit 72cbe2a

Browse files
authored
Merge pull request #23 from jposada202020/improving_docs
improving_docs
2 parents e1abf7d + b773844 commit 72cbe2a

File tree

4 files changed

+61
-16
lines changed

4 files changed

+61
-16
lines changed

README.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,16 @@ displayio driver for ST7735R TFT-LCD displays.
1818
Hardware
1919
=========
2020

21-
1.8" SPI TFT display, 160x128 18-bit color <https://www.adafruit.com/product/618>
22-
Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout <https://www.adafruit.com/product/3533>
23-
1.8" Color TFT LCD display with MicroSD Card Breakout <https://www.adafruit.com/product/358>
24-
Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout <https://www.adafruit.com/product/2088>
25-
Adafruit Mini Color TFT with Joystick FeatherWing <https://www.adafruit.com/product/3321>
21+
* `1.8" SPI TFT display, 160x128 18-bit color
22+
<https://www.adafruit.com/product/618>`_
23+
* `Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout
24+
<https://www.adafruit.com/product/3533>`_
25+
* `1.8" Color TFT LCD display with MicroSD Card Breakout
26+
<https://www.adafruit.com/product/358>`_
27+
* `Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout
28+
<https://www.adafruit.com/product/2088>`_
29+
* `Adafruit Mini Color TFT with Joystick FeatherWing
30+
<https://www.adafruit.com/product/3321>`_
2631

2732
If you have a board with a ST7735B chip, you may want to try
2833
`the Adafruit ST7735 Driver <https://github.com/adafruit/Adafruit_CircuitPython_ST7735>`_.

adafruit_st7735r.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@
1616
1717
**Hardware:**
1818
19-
* 1.8" SPI TFT display, 160x128 18-bit color:
20-
https://www.adafruit.com/product/618
21-
* Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout:
22-
https://www.adafruit.com/product/3533
23-
* 1.8" Color TFT LCD display with MicroSD Card Breakout:
24-
https://www.adafruit.com/product/358
25-
* Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout:
26-
https://www.adafruit.com/product/2088
27-
* Adafruit Mini Color TFT with Joystick FeatherWing:
28-
https://www.adafruit.com/product/3321
19+
* `1.8" SPI TFT display, 160x128 18-bit color
20+
<https://www.adafruit.com/product/618>`_ (Product ID: 618)
21+
* `Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout
22+
<https://www.adafruit.com/product/3533>`_ (Product ID: 3533)
23+
* `1.8" Color TFT LCD display with MicroSD Card Breakout:
24+
<https://www.adafruit.com/product/358>`_ (Product ID: 358)
25+
* `Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout:
26+
<https://www.adafruit.com/product/2088>`_ (Product ID: 2088)
27+
* `Adafruit Mini Color TFT with Joystick FeatherWing:
28+
<https://www.adafruit.com/product/3321>`_ (Product ID: 3321)
2929
3030
**Software and Dependencies:**
3131
3232
* Adafruit CircuitPython firmware for the supported boards:
33-
https://github.com/adafruit/circuitpython/releases
33+
https://circuitpython.org/downloads
3434
3535
"""
3636

docs/examples.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,39 @@ Ensure your device works with this simple test.
66
.. literalinclude:: ../examples/st7735r_simpletest.py
77
:caption: examples/st7735r_simpletest.py
88
:linenos:
9+
10+
128x160 Simple test
11+
--------------------
12+
13+
Example for the 128x160
14+
15+
.. literalinclude:: ../examples/st7735r_128x160_simpletest.py
16+
:caption: examples/st7735r_128x160_simpletest.py
17+
:linenos:
18+
19+
Minitft featherwing test
20+
-------------------------
21+
22+
Simple example for the minitft featherwing
23+
24+
.. literalinclude:: ../examples/st7735r_minitft_featherwing_simpletest.py
25+
:caption: examples/st7735r_minitft_featherwing_simpletest.py
26+
:linenos:
27+
28+
Minitft test
29+
------------
30+
31+
Simple example for the minitft
32+
33+
.. literalinclude:: ../examples/st7735r_minitft_simpletest.py
34+
:caption: examples/st7735r_minitft_simpletest.py
35+
:linenos:
36+
37+
Shield Buttons
38+
--------------
39+
40+
Example for the shield buttons
41+
42+
.. literalinclude:: ../examples/st7735r_18tftshield_buttons.py
43+
:caption: examples/st7735r_18tftshield_buttons.py
44+
:linenos:

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ Table of Contents
2323
.. toctree::
2424
:caption: Tutorials
2525

26+
1.8" TFT Display Breakout and Shield <https://learn.adafruit.com/1-8-tft-display>
27+
Adafruit Mini TFT - 0.96" 160x80 <https://learn.adafruit.com/adafruit-mini-tft-0-dot-96-inch-180x60-breakout>
28+
Adafruit Mini TFT with Joystick Featherwing <https://learn.adafruit.com/adafruit-mini-tft-featherwing>
29+
2630
.. toctree::
2731
:caption: Related Products
2832

0 commit comments

Comments
 (0)