Skip to content
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.

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

updating FontProtocol link to Circuitpython RTD #189

Merged
merged 1 commit into from
Mar 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions adafruit_display_text/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def wrap_text_to_pixels(
:param str string: The text to be wrapped.
:param int max_width: The maximum number of pixels on a line before wrapping.
:param font: The font to use for measuring the text.
:type font: ~FontProtocol
:type font: ~fontio.FontProtocol
:param str indent0: Additional character(s) to add to the first line.
:param str indent1: Additional character(s) to add to all other lines.

Expand Down Expand Up @@ -198,7 +198,7 @@ class LabelBase(Group):

:param font: A font class that has ``get_bounding_box`` and ``get_glyph``.
Must include a capital M for measuring character size.
:type font: ~FontProtocol
:type font: ~fontio.FontProtocol
:param str text: Text to display
:param int color: Color of all text in RGB hex
:param int background_color: Color of the background, use `None` for transparent
Expand Down
2 changes: 1 addition & 1 deletion adafruit_display_text/bitmap_label.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class Label(LabelBase):

:param font: A font class that has ``get_bounding_box`` and ``get_glyph``.
Must include a capital M for measuring character size.
:type font: ~FontProtocol
:type font: ~fontio.FontProtocol
:param str text: Text to display
:param int|Tuple(int, int, int) color: Color of all text in HEX or RGB
:param int|Tuple(int, int, int)|None background_color: Color of the background, use `None`
Expand Down
2 changes: 1 addition & 1 deletion adafruit_display_text/label.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class Label(LabelBase):

:param font: A font class that has ``get_bounding_box`` and ``get_glyph``.
Must include a capital M for measuring character size.
:type font: ~FontProtocol
:type font: ~fontio.FontProtocol
:param str text: Text to display
:param int|Tuple(int, int, int) color: Color of all text in HEX or RGB
:param int|Tuple(int, int, int)|None background_color: Color of the background, use `None`
Expand Down
2 changes: 1 addition & 1 deletion adafruit_display_text/scrolling_label.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ScrollingLabel(bitmap_label.Label):
in order to show the full text if it's larger than the fixed-width.

:param font: The font to use for the label.
:type: ~FontProtocol
:type: ~fontio.FontProtocol
:param int max_characters: The number of characters that sets the fixed-width. Default is 10.
:param str text: The full text to show in the label. If this is longer than
``max_characters`` then the label will scroll to show everything.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
autodoc_mock_imports = ["displayio", "adafruit_bitmap_font"]
autodoc_mock_imports = ["displayio", "adafruit_bitmap_font", "fontio"]


intersphinx_mapping = {
Expand Down