From 5d6ab47947e6d4bbb17ac4de9f12bf2c421e2719 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Sat, 30 Sep 2017 15:21:22 -0400 Subject: [PATCH] Continued documentation tweaking --- README.rst | 34 +++++++++++++++++----------------- api.rst | 2 +- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index 35ad5c3..7b6054e 100644 --- a/README.rst +++ b/README.rst @@ -26,23 +26,23 @@ This is easily achieved by downloading Usage Example ============= -``` -import board -import dotstar_featherwing -wing = dotstar_featherwing.DotstarFeatherwing(board.D13, board.D11) - -xmas = ["..y.w......w", - "..G.....w...", - "..G..w....w.", - ".GGG...w....", - "GGGGG.......", - "wwwwwwwwwwww"] - -xmas_colours = {'w': (0x20, 0x20, 0x20), - 'W': (0xFF, 0xFF, 0xFF), - 'G': (0x00, 0x20, 0x00), - 'y': (0x20, 0x20, 0x00), - 'Y': (0xFF, 0xFF, 0x00)} +.. code-block:: python + import board + import dotstar_featherwing + wing = dotstar_featherwing.DotstarFeatherwing(board.D13, board.D11) + + xmas = ["..y.w......w", + "..G.....w...", + "..G..w....w.", + ".GGG...w....", + "GGGGG.......", + "wwwwwwwwwwww"] + + xmas_colours = {'w': (0x20, 0x20, 0x20), + 'W': (0xFF, 0xFF, 0xFF), + 'G': (0x00, 0x20, 0x00), + 'y': (0x20, 0x20, 0x00), + 'Y': (0xFF, 0xFF, 0x00)} wing.display_coloured_image(xmas, xmas_colours) ``` diff --git a/api.rst b/api.rst index ce7b7b8..eeecdbc 100644 --- a/api.rst +++ b/api.rst @@ -1,5 +1,5 @@ .. If you created a package, create one automodule per module in the package. -.. automodule:: adafruit_dotstar_featherwing +.. automodule:: dotstar_featherwing :members: