From 544f6063798f15b5ceceeb2bc8b4f8068a271fbb Mon Sep 17 00:00:00 2001 From: github-actions Date: Sat, 22 Jun 2024 00:47:19 +0000 Subject: [PATCH] update docs [bot] --- docs/inkycal.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/inkycal.html b/docs/inkycal.html index 2166d2b..e098b4e 100644 --- a/docs/inkycal.html +++ b/docs/inkycal.html @@ -232,14 +232,14 @@ which the given font should be scaled to.

-inkycal.custom.functions.draw_border(image, xy, size, radius=5, thickness=1, shrinkage=(0.1, 0.1))
+inkycal.custom.functions.draw_border(image: <module 'PIL.Image' from '/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'>, xy: ~typing.Tuple[int, int], size: ~typing.Tuple[int, int], radius: int = 5, thickness: int = 1, shrinkage: ~typing.Tuple[int, int] = (0.1, 0.1)) → None

Draws a border at given coordinates.

Args:

  • image: The image on which the border should be drawn (usually im_black or -im_colour.

    • +im_colour).

  • xy: Tuple representing the top-left corner of the border e.g. (32, 100) -where 32 is the x co-ordinate and 100 is the y-coordinate.

    • +where 32 is the x-coordinate and 100 is the y-coordinate.

  • size: Size of the border as a tuple -> (width, height).

  • radius: Radius of the corners, where 0 = plain rectangle, 5 = round corners.

  • thickness: Thickness of the border in pixels.

    • @@ -288,14 +288,14 @@ printed fonts of this function:

    The extracted timezone can be used to show the local time instead of UTC. e.g.

    >>> import arrow
 >>> print(arrow.now()) # returns non-timezone-aware time
->>> print(arrow.now(tz=get_system_tz()) # prints timezone aware time.
+>>> print(arrow.now(tz=get_system_tz())) # prints timezone aware time.
-inkycal.custom.functions.internet_available()
+inkycal.custom.functions.internet_available() → bool

checks if the internet is available.

Attempts to connect to google.com with a timeout of 5 seconds to check if the network can be reached.

@@ -315,7 +315,7 @@ if the network can be reached.

-inkycal.custom.functions.text_wrap(text, font=None, max_width=None)
+inkycal.custom.functions.text_wrap(text: str, font=None, max_width=None)

Splits a very long text into smaller parts

Splits a long text to smaller lines which can fit in a line with max_width. Uses a Font object for more accurate calculations.

@@ -334,7 +334,7 @@ splitting the text into the next chunk.

-inkycal.custom.functions.write(image, xy, box_size, text, font=None, **kwargs)
+inkycal.custom.functions.write(image: <module 'PIL.Image' from '/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'>, xy: ~typing.Tuple[int, int], box_size: ~typing.Tuple[int, int], text: str, font=None, **kwargs)

Writes text on an image.

Writes given text at given position on the specified image.