Skip to content

Commit b8f34db

Browse files
committed
Adding scrolling_label.py and example to documentation
1 parent 316d40c commit b8f34db

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

docs/api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@
1313

1414
.. automodule:: adafruit_display_text.bitmap_label
1515
:members:
16+
17+
.. automodule:: adafruit_display_text.scrolling_label
18+
:members:

docs/examples.rst

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Simple test
1+
Simple Test
22
------------
33

44
Ensure your device works with this simple test.
@@ -7,7 +7,7 @@ Ensure your device works with this simple test.
77
:caption: examples/display_text_simpletest.py
88
:linenos:
99

10-
Bitmap_label Simple test
10+
Bitmap_label Simple Test
1111
------------------------
1212

1313
Simple test using bitmap_label to display text
@@ -16,6 +16,15 @@ Simple test using bitmap_label to display text
1616
:caption: examples/display_text_bitmap_label_simpletest.py
1717
:linenos:
1818

19+
ScrollingLabel Simple Test
20+
---------------------------
21+
22+
Simple test using scrolling_label to display text
23+
24+
.. literalinclude:: ../examples/display_text_scrolling_label.py
25+
:caption: examples/display_text_scrolling_label.py
26+
:linenos:
27+
1928
Label vs Bitmap_label Comparison
2029
--------------------------------
2130

@@ -25,7 +34,7 @@ Example to compare Label and Bitmap_Label characteristics
2534
:caption: examples/display_text_label_vs_bitmap_label_comparison.py
2635
:linenos:
2736

28-
Background color example
37+
Background Color Example
2938
------------------------
3039

3140
Show the text backgrounds features
@@ -34,7 +43,7 @@ Show the text backgrounds features
3443
:caption: examples/display_text_background_color.py
3544
:linenos:
3645

37-
Text padding example
46+
Text Padding Example
3847
--------------------
3948

4049
Show the text padding features in all directions
@@ -61,7 +70,7 @@ Boundingbox demonstration
6170
:caption: examples/display_text_textarea_boundingbox.py
6271
:linenos:
6372

64-
Align Baseline example
73+
Align Baseline Example
6574
----------------------
6675

6776
Demonstrate how to align different labels to a common horizontal line
@@ -70,7 +79,7 @@ Demonstrate how to align different labels to a common horizontal line
7079
:caption: examples/display_text_label_align_baseline_comparison.py
7180
:linenos:
7281

73-
Magtag example
82+
Magtag Example
7483
--------------
7584

7685
Uses the MAGTAG to display some text
@@ -79,7 +88,7 @@ Uses the MAGTAG to display some text
7988
:caption: examples/display_text_magtag.py
8089
:linenos:
8190

82-
MatrixPortal example
91+
MatrixPortal Example
8392
--------------------
8493

8594
Uses the MatrixPortal to display some text
@@ -88,7 +97,7 @@ Uses the MatrixPortal to display some text
8897
:caption: examples/display_text_matrixportal.py
8998
:linenos:
9099

91-
PyPortal example
100+
PyPortal Example
92101
----------------
93102

94103
Uses the Pyportal to display some text
@@ -97,7 +106,7 @@ Uses the Pyportal to display some text
97106
:caption: examples/display_text_pyportal.py
98107
:linenos:
99108

100-
Wraptest example
109+
Wraptest Example
101110
----------------
102111

103112
Illustrates the wraptest feature

0 commit comments

Comments
 (0)