Skip to content

improving_docs #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 22, 2021
Merged

improving_docs #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,16 @@ displayio driver for ST7735R TFT-LCD displays.
Hardware
=========

1.8" SPI TFT display, 160x128 18-bit color <https://www.adafruit.com/product/618>
Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout <https://www.adafruit.com/product/3533>
1.8" Color TFT LCD display with MicroSD Card Breakout <https://www.adafruit.com/product/358>
Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout <https://www.adafruit.com/product/2088>
Adafruit Mini Color TFT with Joystick FeatherWing <https://www.adafruit.com/product/3321>
* `1.8" SPI TFT display, 160x128 18-bit color
<https://www.adafruit.com/product/618>`_
* `Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout
<https://www.adafruit.com/product/3533>`_
* `1.8" Color TFT LCD display with MicroSD Card Breakout
<https://www.adafruit.com/product/358>`_
* `Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout
<https://www.adafruit.com/product/2088>`_
* `Adafruit Mini Color TFT with Joystick FeatherWing
<https://www.adafruit.com/product/3321>`_

If you have a board with a ST7735B chip, you may want to try
`the Adafruit ST7735 Driver <https://github.com/adafruit/Adafruit_CircuitPython_ST7735>`_.
Expand Down
22 changes: 11 additions & 11 deletions adafruit_st7735r.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@

**Hardware:**

* 1.8" SPI TFT display, 160x128 18-bit color:
https://www.adafruit.com/product/618
* Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout:
https://www.adafruit.com/product/3533
* 1.8" Color TFT LCD display with MicroSD Card Breakout:
https://www.adafruit.com/product/358
* Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout:
https://www.adafruit.com/product/2088
* Adafruit Mini Color TFT with Joystick FeatherWing:
https://www.adafruit.com/product/3321
* `1.8" SPI TFT display, 160x128 18-bit color
<https://www.adafruit.com/product/618>`_ (Product ID: 618)
* `Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout
<https://www.adafruit.com/product/3533>`_ (Product ID: 3533)
* `1.8" Color TFT LCD display with MicroSD Card Breakout:
<https://www.adafruit.com/product/358>`_ (Product ID: 358)
* `Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout:
<https://www.adafruit.com/product/2088>`_ (Product ID: 2088)
* `Adafruit Mini Color TFT with Joystick FeatherWing:
<https://www.adafruit.com/product/3321>`_ (Product ID: 3321)

**Software and Dependencies:**

* Adafruit CircuitPython firmware for the supported boards:
https://github.com/adafruit/circuitpython/releases
https://circuitpython.org/downloads

"""

Expand Down
36 changes: 36 additions & 0 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,39 @@ Ensure your device works with this simple test.
.. literalinclude:: ../examples/st7735r_simpletest.py
:caption: examples/st7735r_simpletest.py
:linenos:

128x160 Simple test
--------------------

Example for the 128x160

.. literalinclude:: ../examples/st7735r_128x160_simpletest.py
:caption: examples/st7735r_128x160_simpletest.py
:linenos:

Minitft featherwing test
-------------------------

Simple example for the minitft featherwing

.. literalinclude:: ../examples/st7735r_minitft_featherwing_simpletest.py
:caption: examples/st7735r_minitft_featherwing_simpletest.py
:linenos:

Minitft test
------------

Simple example for the minitft

.. literalinclude:: ../examples/st7735r_minitft_simpletest.py
:caption: examples/st7735r_minitft_simpletest.py
:linenos:

Shield Buttons
--------------

Example for the shield buttons

.. literalinclude:: ../examples/st7735r_18tftshield_buttons.py
:caption: examples/st7735r_18tftshield_buttons.py
:linenos:
4 changes: 4 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Table of Contents
.. toctree::
:caption: Tutorials

1.8" TFT Display Breakout and Shield <https://learn.adafruit.com/1-8-tft-display>
Adafruit Mini TFT - 0.96" 160x80 <https://learn.adafruit.com/adafruit-mini-tft-0-dot-96-inch-180x60-breakout>
Adafruit Mini TFT with Joystick Featherwing <https://learn.adafruit.com/adafruit-mini-tft-featherwing>

.. toctree::
:caption: Related Products

Expand Down