Skip to content

Commit c7f30ee

Browse files
authored
Merge pull request #80 from jposada202020/updating_examples
adding examples to Readthedocs
2 parents 29fe3f0 + fe86435 commit c7f30ee

File tree

1 file changed

+95
-5
lines changed

1 file changed

+95
-5
lines changed

docs/examples.rst

+95-5
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,42 @@ Ensure your device works with this simple test.
77
:caption: examples/displayio_layout_simpletest.py
88
:linenos:
99

10+
Cartesian plane simple test
11+
---------------------------
12+
13+
Create a simple plot plane.
14+
15+
.. literalinclude:: ../examples/displayio_layout_cartesian_simpletest.py
16+
:caption: examples/displayio_layout_cartesian_simpletest.py
17+
:linenos:
18+
19+
Cartesian lineplot
20+
---------------------
21+
22+
Create a lineplot.
23+
24+
.. literalinclude:: ../examples/displayio_layout_cartesian_lineplot.py
25+
:caption: examples/displayio_layout_cartesian_lineplot.py
26+
:linenos:
27+
28+
Cartesian Advanced
29+
---------------------
30+
31+
Create three different cartesian planes in the display
32+
33+
.. literalinclude:: ../examples/displayio_layout_cartesian_advanced_test.py
34+
:caption: examples/displayio_layout_cartesian_advanced_test.py
35+
:linenos:
36+
37+
GridLayout simple text
38+
------------------------
39+
40+
Make green and purple rectangles and a "Hello World" label
41+
42+
.. literalinclude:: ../examples/displayio_layout_gridlayout_simpletest.py
43+
:caption: examples/displayio_layout_gridlayout_simpletest.py
44+
:linenos:
45+
1046
GridLayout divider lines example
1147
--------------------------------
1248

@@ -16,6 +52,15 @@ Create GridLayouts with divider lines.
1652
:caption: examples/displayio_layout_gridlayout_dividers.py
1753
:linenos:
1854

55+
GridLayout Get Cell
56+
-------------------------
57+
58+
Make green and purple rectangles and then update the color and text values of the labels using the get_cell() function.
59+
60+
.. literalinclude:: ../examples/displayio_layout_grid_layout_get_cell_test.py
61+
:caption: examples/displayio_layout_grid_layout_get_cell_test.py
62+
:linenos:
63+
1964
Pygame simple test
2065
------------------
2166

@@ -25,6 +70,42 @@ Display Hello World using Blinka_Displayio_PyGameDisplay.
2570
:caption: examples/displayio_layout_gridlayout_pygame_display_simpletest.py
2671
:linenos:
2772

73+
Icon Animated simple test
74+
-------------------------
75+
76+
Creates two animated icons with touch response: zoom and shrink animations.
77+
78+
.. literalinclude:: ../examples/displayio_layout_icon_animated_simpletest.py
79+
:caption: examples/displayio_layout_icon_animated_simpletest.py
80+
:linenos:
81+
82+
Page Layout simple test
83+
-------------------------
84+
85+
Make a PageLayout with two pages and change between them.
86+
87+
.. literalinclude:: ../examples/displayio_layout_page_layout_simpletest.py
88+
:caption: examples/displayio_layout_page_layout_simpletest.py
89+
:linenos:
90+
91+
Page Layout advanced test
92+
-------------------------
93+
94+
Make a PageLayout and illustrate all of it's features
95+
96+
.. literalinclude:: ../examples/displayio_layout_page_layout_advancedtest.py
97+
:caption: examples/displayio_layout_page_layout_advancedtest.py
98+
:linenos:
99+
100+
Pygame Switch example
101+
-------------------------
102+
103+
Make a GridLayout with some Labels in its cells. Displayed with Blinka_Displayio_PyGameDisplay
104+
105+
.. literalinclude:: ../examples/displayio_layout_page_layout_advancedtest.py
106+
:caption: examples/displayio_layout_page_layout_advancedtest.py
107+
:linenos:
108+
28109
Switch simple test
29110
------------------
30111

@@ -52,11 +133,20 @@ Create three FlipInput selectors.
52133
:caption: examples/displayio_layout_flip_input_simpletest.py
53134
:linenos:
54135

55-
Cartesian plane simple test
56-
---------------------------
136+
Tab Layout simple test
137+
-----------------------
57138

58-
Create a simple plot plane.
139+
Make a TabLayout and illustrate the most basic features and usage.
59140

60-
.. literalinclude:: ../examples/displayio_layout_cartesian_simpletest.py
61-
:caption: examples/displayio_layout_cartesian_simpletest.py
141+
.. literalinclude:: ../examples/displayio_layout_tab_layout_simpletest.py
142+
:caption: examples/displayio_layout_tab_layout_simpletest.py
143+
:linenos:
144+
145+
Tab Layout touch test
146+
---------------------
147+
148+
Make a TabLayout change tabs with the touchscreen
149+
150+
.. literalinclude:: ../examples/displayio_layout_tab_layout_touchtest.py
151+
:caption: examples/ddisplayio_layout_tab_layout_touchtest.py
62152
:linenos:

0 commit comments

Comments
 (0)