From b773844f5176a7be977e122ff9a0bd3935ca58f6 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 22 Jun 2021 08:48:56 -0400 Subject: [PATCH] improving_docs --- README.rst | 15 ++++++++++----- adafruit_st7735r.py | 22 +++++++++++----------- docs/examples.rst | 36 ++++++++++++++++++++++++++++++++++++ docs/index.rst | 4 ++++ 4 files changed, 61 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 92700f8..2a897f7 100644 --- a/README.rst +++ b/README.rst @@ -18,11 +18,16 @@ displayio driver for ST7735R TFT-LCD displays. Hardware ========= -1.8" SPI TFT display, 160x128 18-bit color -Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout -1.8" Color TFT LCD display with MicroSD Card Breakout -Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout -Adafruit Mini Color TFT with Joystick FeatherWing +* `1.8" SPI TFT display, 160x128 18-bit color + `_ +* `Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout + `_ +* `1.8" Color TFT LCD display with MicroSD Card Breakout + `_ +* `Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout + `_ +* `Adafruit Mini Color TFT with Joystick FeatherWing + `_ If you have a board with a ST7735B chip, you may want to try `the Adafruit ST7735 Driver `_. diff --git a/adafruit_st7735r.py b/adafruit_st7735r.py index 8eb76b3..b816b63 100755 --- a/adafruit_st7735r.py +++ b/adafruit_st7735r.py @@ -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 + `_ (Product ID: 618) +* `Adafruit 0.96" 160x80 Color TFT Display w/ MicroSD Card Breakout + `_ (Product ID: 3533) +* `1.8" Color TFT LCD display with MicroSD Card Breakout: + `_ (Product ID: 358) +* `Adafruit 1.44" Color TFT LCD Display with MicroSD Card breakout: + `_ (Product ID: 2088) +* `Adafruit Mini Color TFT with Joystick FeatherWing: + `_ (Product ID: 3321) **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases + https://circuitpython.org/downloads """ diff --git a/docs/examples.rst b/docs/examples.rst index c8c84e7..0688eaa 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -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: diff --git a/docs/index.rst b/docs/index.rst index 31a366c..e231a1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,10 @@ Table of Contents .. toctree:: :caption: Tutorials + 1.8" TFT Display Breakout and Shield + Adafruit Mini TFT - 0.96" 160x80 + Adafruit Mini TFT with Joystick Featherwing + .. toctree:: :caption: Related Products