Skip to content

Exposing examples to the API documentation and other small changes #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2021
Merged

Exposing examples to the API documentation and other small changes #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,43 @@ Ensure your device works with this simple test.
.. literalinclude:: ../examples/bitmap_font_simpletest.py
:caption: examples/bitmap_font_simpletest.py
:linenos:

Label simple test
-----------------

This example uses ``adafruit_display_text.label`` to display text using a custom font
loaded by ``adafruit_bitmap_font``

.. literalinclude:: ../examples/bitmap_font_label_simpletest.py
:caption: examples/bitmap_font_label_simpletest.py
:linenos:

Displayio simple test
---------------------

This example uses ``adafruit_bitmap_font`` to load a font and fill a bitmap with
pixels matching glyphs from a given String

.. literalinclude:: ../examples/bitmap_font_displayio_simpletest.py
:caption: examples/bitmap_font_displayio_simpletest.py
:linenos:

Label MagTag
------------

This example uses ``adafruit_display_text.label`` to display text using a custom font
loaded by ``adafruit_bitmap_font``.

.. literalinclude:: ../examples/bitmap_font_label_magtag.py
:caption: examples/bitmap_font_label_magtag.py
:linenos:

Fork Awesome icons
------------------

This example uses ``adafruit_display_text.label`` to display fork awesome
icons.

.. literalinclude:: ../examples/bitmap_font_label_forkawesome.py
:caption: examples/bitmap_font_label_forkawesome.py
:linenos:
6 changes: 3 additions & 3 deletions examples/bitmap_font_displayio_simpletest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

"""
This example runs on PyPortal, or any Circuit Python device
with a built-in screen that is at least 320x240 pixels.
with a built-in screen.

It will use adafruit_bitmap_font to load a font and fill a
bitmap with pixels matching glyphs from a given String
Expand All @@ -14,7 +14,7 @@
import displayio
from adafruit_bitmap_font import bitmap_font

# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
display = board.DISPLAY
Expand All @@ -25,7 +25,7 @@

font = bitmap_font.load_font(font_file)

bitmap = displayio.Bitmap(320, 240, 2)
bitmap = displayio.Bitmap(display.width, display.height, 2)

palette = displayio.Palette(2)

Expand Down
4 changes: 2 additions & 2 deletions examples/bitmap_font_label_forkawesome.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: MIT

"""
This example uses addfruit_display_text.label to display fork awesome
This example uses adafruit_display_text.label to display fork awesome
icons.

More info here: https://emergent.unpythonic.net/01606790241
Expand All @@ -13,7 +13,7 @@
from adafruit_display_text import label
from adafruit_bitmap_font import bitmap_font

# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
display = board.DISPLAY
Expand Down
4 changes: 2 additions & 2 deletions examples/bitmap_font_label_magtag.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: MIT

"""
This example uses addfruit_display_text.label to display text using a custom font
This example uses adafruit_display_text.label to display text using a custom font
loaded by adafruit_bitmap_font.
Adapted for use on MagTag
"""
Expand All @@ -11,7 +11,7 @@
from adafruit_display_text import label
from adafruit_bitmap_font import bitmap_font

# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
display = board.DISPLAY
Expand Down
4 changes: 2 additions & 2 deletions examples/bitmap_font_label_simpletest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
# SPDX-License-Identifier: MIT

"""
This example uses addfruit_display_text.label to display text using a custom font
This example uses adafruit_display_text.label to display text using a custom font
loaded by adafruit_bitmap_font
"""

import board
from adafruit_display_text import label
from adafruit_bitmap_font import bitmap_font

# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
display = board.DISPLAY
Expand Down