Skip to content

Commit a296ddc

Browse files
committed
updated README
1 parent ad07358 commit a296ddc

File tree

1 file changed

+28
-19
lines changed

1 file changed

+28
-19
lines changed

README.rst

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,19 @@ Introduction
99
:target: https://discord.gg/nBQh6qu
1010
:alt: Discord
1111
12-
.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_RGB_Display.svg?branch=master
13-
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_RGB_Display
14-
:alt: Build Status
12+
Port of display drivers from https://github.com/adafruit/micropython-adafruit-rgb-display to Adafruit CircuitPython for use on Adafruit's SAMD21-based and other CircuitPython boards.
1513

16-
Port of display drivers from https://github.com/adafruit/micropython-adafruit-rgb-display
17-
to Adafruit CircuitPython for use on Adafruit's SAMD21-based and other CircuitPython
18-
boards.
19-
20-
This driver depends on the Adafruit CircuitPython BusDevice module being installed on the
21-
board too: https://github.com/adafruit/Adafruit_MicroPython_BusDevice
22-
23-
Note that this driver currently won't work on micropython.org firmware, instead
14+
.. note:: This driver currently won't work on micropython.org firmware, instead
2415
you want the micropython-adafruit-rgb-display driver linked above!
2516

17+
This CircuitPython driver currently supports displays that use the following display-driver chips: HX8353, ILI9341, S6D02A1, SSD1331, SSD1351, and ST7735.
18+
2619
Dependencies
2720
=============
2821
This driver depends on:
2922

3023
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
24+
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
3125

3226
Please ensure all dependencies are available on the CircuitPython filesystem.
3327
This is easily achieved by downloading
@@ -70,14 +64,6 @@ Usage Example
7064
# Pause 2 seconds.
7165
time.sleep(2)
7266
73-
API Reference
74-
=============
75-
76-
.. toctree::
77-
:maxdepth: 2
78-
79-
api
80-
8167
Contributing
8268
============
8369

@@ -108,3 +94,26 @@ Then run the build:
10894
.. code-block:: shell
10995
11096
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rgb_display --library_location .
97+
98+
Sphinx documentation
99+
-----------------------
100+
101+
Sphinx is used to build the documentation based on rST files and comments in the code. First,
102+
install dependencies (feel free to reuse the virtual environment from above):
103+
104+
.. code-block:: shell
105+
106+
python3 -m venv .env
107+
source .env/bin/activate
108+
pip install Sphinx sphinx-rtd-theme
109+
110+
Now, once you have the virtual environment activated:
111+
112+
.. code-block:: shell
113+
114+
cd docs
115+
sphinx-build -E -W -b html . _build/html
116+
117+
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
118+
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
119+
locally verify it will pass.

0 commit comments

Comments
 (0)