From b2e5691355f68309c7a37dc2e0c7d3999af37c3a Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Thu, 23 Mar 2023 23:46:07 -0400 Subject: [PATCH] updating FontProtocol link to Circuitpython RTD --- adafruit_display_text/__init__.py | 4 ++-- adafruit_display_text/bitmap_label.py | 2 +- adafruit_display_text/label.py | 2 +- adafruit_display_text/scrolling_label.py | 2 +- docs/conf.py | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/adafruit_display_text/__init__.py b/adafruit_display_text/__init__.py index 017f6be..be32a1e 100755 --- a/adafruit_display_text/__init__.py +++ b/adafruit_display_text/__init__.py @@ -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. @@ -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 diff --git a/adafruit_display_text/bitmap_label.py b/adafruit_display_text/bitmap_label.py index d8758ce..901b3fc 100755 --- a/adafruit_display_text/bitmap_label.py +++ b/adafruit_display_text/bitmap_label.py @@ -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` diff --git a/adafruit_display_text/label.py b/adafruit_display_text/label.py index 3cea653..c448b07 100755 --- a/adafruit_display_text/label.py +++ b/adafruit_display_text/label.py @@ -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` diff --git a/adafruit_display_text/scrolling_label.py b/adafruit_display_text/scrolling_label.py index c2d52de..a4039b7 100644 --- a/adafruit_display_text/scrolling_label.py +++ b/adafruit_display_text/scrolling_label.py @@ -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. diff --git a/docs/conf.py b/docs/conf.py index b152a60..b6c97ae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 = {