|
diff --git a/docs/index.html b/docs/index.html
index ebd979c..a193902 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -47,7 +47,8 @@
Contents:
-- Display
-
+- Display
+- Modules
- Custom functions
auto_fontsize()draw_border()
-Display
-
+Display
+Modules
Custom functions
-
--
-calibrate(cycles=3)
-Calibrates the display to retain crisp colours
-Flushes the selected display several times with it’s supported colours,
-removing any previous effects of ghosting.
-
-- Args:
-
-
+
+
+Modules
+Agenda
+.. automodule:: inkycal.modules.inkycal_agenda.Agenda
+
+
+- members:
+
- It’s recommended to calibrate the display after every 6 display updates
-for best results. For black-white only displays, calibration is less
-critical, but not calibrating regularly results in grey-ish text.
- Please note that calibration takes a while to complete. 3 cycles may
-take 10 minutes on black-white E-Papers while it takes 20 minutes on coloured
-E-Paper displays.
-
-
-
--
-classmethod get_display_names() → list
-Prints all supported E-Paper models.
-Fetches all filenames in driver folder and prints them on the console.
-
-- Returns:
Printed version of all supported Displays.
-
+Calendar
+.. automodule:: inkycal.modules.inkycal_calendar.Calendar
+
+
+- members:
+
- Use one of the models to intilialize the Display class in order to gain
-access to the E-Paper.
- You can use this function directly without creating the Display class:
- >>> Display.get_display_names()
-
-
-
-
-
--
-classmethod get_display_size(model_name) -> (<class 'int'>, <class 'int'>)
-Returns the size of the display as a tuple -> (width, height)
-Looks inside “drivers” folder for the given model name, then returns it’s
-size.
-
-- Args:
-
-
-- Returns:
(width, height) ->tuple, showing the size of the display
-
-You can use this function directly without creating the Display class:
->>> Display.get_display_size('model_name')
-
-
-
-
--
-render(im_black: <module 'PIL.Image' from '/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'>, im_colour: <module 'PIL.Image' from '/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'>) → None
-Renders an image on the selected E-Paper display.
-Initlializes the E-Paper display, sends image data and executes command
-to update the display.
-
-- Args:
-im_black: The image for the black-pixels. Anything in this image that is
-black is rendered as black on the display. This is required and ideally
-should be a black-white image. im_colour: For E-Paper displays supporting colour, a separate image,
-ideally black-white is required for the coloured pixels. Anything that is
-black in this image will show up as either red/yellow.
-
-Rendering an image for black-white E-Paper displays:
->>> sample_image = Image.open('path/to/file.png')
->>> display = Display('my_black_white_display')
->>> display.render(sample_image)
-
- Rendering black-white on coloured E-Paper displays:
->>> sample_image = Image.open(‘path/to/file.png’)
->>> display = Display(‘my_coloured_display’)
->>> display.render(sample_image, sample_image)
-Rendering coloured image where 2 images are available:
->>> black_image = Image.open('path/to/file.png') # black pixels
->>> colour_image = Image.open('path/to/file.png') # coloured pixels
->>> display = Display('my_coloured_display')
->>> display.render(black_image, colour_image)
-
-
-
-
-
+
Custom functions
diff --git a/docs/objects.inv b/docs/objects.inv
index 70abe1d..97338b1 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index 137527f..193b566 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -48,7 +48,8 @@
Contents:
|