deploy: 0cbc959

salt-die · Sep 12, 2024 · 2cc6063 · 2cc6063
commit 2cc6063
Show file tree

Hide file tree

Showing 278 changed files with 105,916 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 37bd1c24a84005e5d5a824d0defbb1b2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/reference/generated/batgrl.app.doctree b/.doctrees/reference/generated/batgrl.app.doctree
diff --git a/.doctrees/reference/generated/batgrl.colors.color_types.doctree b/.doctrees/reference/generated/batgrl.colors.color_types.doctree
diff --git a/.doctrees/reference/generated/batgrl.colors.colors.doctree b/.doctrees/reference/generated/batgrl.colors.colors.doctree
diff --git a/.doctrees/reference/generated/batgrl.colors.doctree b/.doctrees/reference/generated/batgrl.colors.doctree
diff --git a/.doctrees/reference/generated/batgrl.colors.gradients.doctree b/.doctrees/reference/generated/batgrl.colors.gradients.doctree
diff --git a/.doctrees/reference/generated/batgrl.easings.doctree b/.doctrees/reference/generated/batgrl.easings.doctree
diff --git a/.doctrees/reference/generated/batgrl.figfont.doctree b/.doctrees/reference/generated/batgrl.figfont.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.animation.doctree b/.doctrees/reference/generated/batgrl.gadgets.animation.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.ans_viewer.doctree b/.doctrees/reference/generated/batgrl.gadgets.ans_viewer.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.bar_chart.doctree b/.doctrees/reference/generated/batgrl.gadgets.bar_chart.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.button_behavior.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.button_behavior.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.focusable.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.focusable.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.grabbable.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.grabbable.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.movable.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.movable.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.movable_children.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.movable_children.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.themable.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.themable.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.behaviors.toggle_button_behavior.doctree b/.doctrees/reference/generated/batgrl.gadgets.behaviors.toggle_button_behavior.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.box_image.doctree b/.doctrees/reference/generated/batgrl.gadgets.box_image.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.braille_image.doctree b/.doctrees/reference/generated/batgrl.gadgets.braille_image.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.braille_video.doctree b/.doctrees/reference/generated/batgrl.gadgets.braille_video.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.button.doctree b/.doctrees/reference/generated/batgrl.gadgets.button.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.color_picker.doctree b/.doctrees/reference/generated/batgrl.gadgets.color_picker.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.console.doctree b/.doctrees/reference/generated/batgrl.gadgets.console.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.data_table.doctree b/.doctrees/reference/generated/batgrl.gadgets.data_table.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.digital_display.doctree b/.doctrees/reference/generated/batgrl.gadgets.digital_display.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.doctree b/.doctrees/reference/generated/batgrl.gadgets.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.file_chooser.doctree b/.doctrees/reference/generated/batgrl.gadgets.file_chooser.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.flat_toggle.doctree b/.doctrees/reference/generated/batgrl.gadgets.flat_toggle.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.gadget.doctree b/.doctrees/reference/generated/batgrl.gadgets.gadget.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.graphic_field.doctree b/.doctrees/reference/generated/batgrl.gadgets.graphic_field.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.graphics.doctree b/.doctrees/reference/generated/batgrl.gadgets.graphics.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.grid_layout.doctree b/.doctrees/reference/generated/batgrl.gadgets.grid_layout.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.image.doctree b/.doctrees/reference/generated/batgrl.gadgets.image.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.line_plot.doctree b/.doctrees/reference/generated/batgrl.gadgets.line_plot.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.markdown.doctree b/.doctrees/reference/generated/batgrl.gadgets.markdown.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.menu.doctree b/.doctrees/reference/generated/batgrl.gadgets.menu.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.pane.doctree b/.doctrees/reference/generated/batgrl.gadgets.pane.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.parallax.doctree b/.doctrees/reference/generated/batgrl.gadgets.parallax.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.progress_bar.doctree b/.doctrees/reference/generated/batgrl.gadgets.progress_bar.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.raycaster.doctree b/.doctrees/reference/generated/batgrl.gadgets.raycaster.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.recycle_view.doctree b/.doctrees/reference/generated/batgrl.gadgets.recycle_view.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.scroll_view.doctree b/.doctrees/reference/generated/batgrl.gadgets.scroll_view.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.shadow_caster.doctree b/.doctrees/reference/generated/batgrl.gadgets.shadow_caster.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.slider.doctree b/.doctrees/reference/generated/batgrl.gadgets.slider.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.sparkline.doctree b/.doctrees/reference/generated/batgrl.gadgets.sparkline.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.split_layout.doctree b/.doctrees/reference/generated/batgrl.gadgets.split_layout.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.stack_layout.doctree b/.doctrees/reference/generated/batgrl.gadgets.stack_layout.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.tabs.doctree b/.doctrees/reference/generated/batgrl.gadgets.tabs.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text.doctree b/.doctrees/reference/generated/batgrl.gadgets.text.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_animation.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_animation.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_effects.beams.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_effects.beams.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_effects.black_hole.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_effects.black_hole.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_effects.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_effects.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_effects.ring.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_effects.ring.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_effects.spotlights.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_effects.spotlights.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_field.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_field.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_pad.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_pad.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.text_raycaster.doctree b/.doctrees/reference/generated/batgrl.gadgets.text_raycaster.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.textbox.doctree b/.doctrees/reference/generated/batgrl.gadgets.textbox.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.tiled_image.doctree b/.doctrees/reference/generated/batgrl.gadgets.tiled_image.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.toggle_button.doctree b/.doctrees/reference/generated/batgrl.gadgets.toggle_button.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.tree_view.doctree b/.doctrees/reference/generated/batgrl.gadgets.tree_view.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.video.doctree b/.doctrees/reference/generated/batgrl.gadgets.video.doctree
diff --git a/.doctrees/reference/generated/batgrl.gadgets.window.doctree b/.doctrees/reference/generated/batgrl.gadgets.window.doctree
diff --git a/.doctrees/reference/generated/batgrl.geometry.basic.doctree b/.doctrees/reference/generated/batgrl.geometry.basic.doctree
diff --git a/.doctrees/reference/generated/batgrl.geometry.doctree b/.doctrees/reference/generated/batgrl.geometry.doctree
diff --git a/.doctrees/reference/generated/batgrl.geometry.motion.doctree b/.doctrees/reference/generated/batgrl.geometry.motion.doctree
diff --git a/.doctrees/reference/generated/batgrl.geometry.regions.doctree b/.doctrees/reference/generated/batgrl.geometry.regions.doctree
diff --git a/.doctrees/reference/generated/batgrl.terminal.events.doctree b/.doctrees/reference/generated/batgrl.terminal.events.doctree
diff --git a/.doctrees/reference/generated/batgrl.text_tools.doctree b/.doctrees/reference/generated/batgrl.text_tools.doctree
diff --git a/.doctrees/reference/generated/batgrl.texture_tools.doctree b/.doctrees/reference/generated/batgrl.texture_tools.doctree
diff --git a/.doctrees/reference/index.doctree b/.doctrees/reference/index.doctree
diff --git a/.doctrees/user/batgrl_faq.doctree b/.doctrees/user/batgrl_faq.doctree
diff --git a/.doctrees/user/gadget_tree.doctree b/.doctrees/user/gadget_tree.doctree
diff --git a/.doctrees/user/gadgets.doctree b/.doctrees/user/gadgets.doctree
diff --git a/.doctrees/user/index.doctree b/.doctrees/user/index.doctree
diff --git a/.doctrees/user/pong_tutorial.doctree b/.doctrees/user/pong_tutorial.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,19 @@
+**********************
+batgrl Documentation
+**********************
+
+Welcome to the batgrl docs. batgrl stands for badass terminal graphics library.
+It can render transparent images, animations, or videos. Perfect for simulation
+visualizations, games, or GUIs.
+
+.. toctree::
+   :maxdepth: 1
+
+   User Guide <user/index>
+   API reference <reference/index>
+
+**Version**: |release|
+
+**Links**:
+`Source <https://github.com/salt-die/batgrl>`_ |
+`Examples <https://github.com/salt-die/batgrl/tree/main/examples>`_
diff --git a/_sources/reference/generated/batgrl.app.rst.txt b/_sources/reference/generated/batgrl.app.rst.txt
@@ -0,0 +1,18 @@
+batgrl.app
+==========
+
+.. automodule:: batgrl.app
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      run_gadget_as_app
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      App
+
diff --git a/_sources/reference/generated/batgrl.colors.color_types.rst.txt b/_sources/reference/generated/batgrl.colors.color_types.rst.txt
@@ -0,0 +1,23 @@
+batgrl.colors.color\_types
+==========================
+
+.. automodule:: batgrl.colors.color_types
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      _to_hex
+      validate_ahexcode
+      validate_hexcode
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AColor
+      Color
+      ColorPair
+      ColorTheme
+
diff --git a/_sources/reference/generated/batgrl.colors.colors.rst.txt b/_sources/reference/generated/batgrl.colors.colors.rst.txt
@@ -0,0 +1,37 @@
+batgrl.colors.colors
+====================
+
+.. automodule:: batgrl.colors.colors
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      WHITE
+      BLACK
+      RED
+      GREEN
+      BLUE
+      YELLOW
+      CYAN
+      MAGENTA
+      AWHITE
+      ABLACK
+      ARED
+      AGREEN
+      ABLUE
+      AYELLOW
+      ACYAN
+      AMAGENTA
+      TRANSPARENT
+      DEFAULT_COLOR_THEME
+      DEFAULT_PRIMARY_FG
+      DEFAULT_PRIMARY_BG
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Neptune
+
diff --git a/_sources/reference/generated/batgrl.colors.gradients.rst.txt b/_sources/reference/generated/batgrl.colors.gradients.rst.txt
@@ -0,0 +1,16 @@
+batgrl.colors.gradients
+=======================
+
+.. automodule:: batgrl.colors.gradients
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      darken_only
+      gradient
+      lerp_colors
+      lighten_only
+      rainbow_gradient
+
diff --git a/_sources/reference/generated/batgrl.colors.rst.txt b/_sources/reference/generated/batgrl.colors.rst.txt
@@ -0,0 +1,15 @@
+batgrl.colors
+=============
+
+.. automodule:: batgrl.colors
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   color_types
+   colors
+   gradients
diff --git a/_sources/reference/generated/batgrl.easings.rst.txt b/_sources/reference/generated/batgrl.easings.rst.txt
@@ -0,0 +1,48 @@
+batgrl.easings
+==============
+
+.. automodule:: batgrl.easings
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      Easing
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      in_back
+      in_bounce
+      in_circ
+      in_cubic
+      in_elastic
+      in_exp
+      in_out_back
+      in_out_bounce
+      in_out_circ
+      in_out_cubic
+      in_out_elastic
+      in_out_exp
+      in_out_quad
+      in_out_quart
+      in_out_quint
+      in_out_sine
+      in_quad
+      in_quart
+      in_quint
+      in_sine
+      linear
+      out_back
+      out_bounce
+      out_circ
+      out_cubic
+      out_elastic
+      out_exp
+      out_quad
+      out_quart
+      out_quint
+      out_sine
+
diff --git a/_sources/reference/generated/batgrl.figfont.rst.txt b/_sources/reference/generated/batgrl.figfont.rst.txt
@@ -0,0 +1,13 @@
+batgrl.figfont
+==============
+
+.. automodule:: batgrl.figfont
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      FIGFont
+      FullLayout
+
diff --git a/_sources/reference/generated/batgrl.gadgets.animation.rst.txt b/_sources/reference/generated/batgrl.gadgets.animation.rst.txt
@@ -0,0 +1,18 @@
+batgrl.gadgets.animation
+========================
+
+.. automodule:: batgrl.gadgets.animation
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      _check_frame_durations
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Animation
+
diff --git a/_sources/reference/generated/batgrl.gadgets.ans_viewer.rst.txt b/_sources/reference/generated/batgrl.gadgets.ans_viewer.rst.txt
@@ -0,0 +1,13 @@
+batgrl.gadgets.ans\_viewer
+==========================
+
+.. automodule:: batgrl.gadgets.ans_viewer
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AnsViewer
+      _AnsReader
+
diff --git a/_sources/reference/generated/batgrl.gadgets.bar_chart.rst.txt b/_sources/reference/generated/batgrl.gadgets.bar_chart.rst.txt
@@ -0,0 +1,13 @@
+batgrl.gadgets.bar\_chart
+=========================
+
+.. automodule:: batgrl.gadgets.bar_chart
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BarChart
+      _BarChartProperty
+
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.button_behavior.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.button_behavior.rst.txt
@@ -0,0 +1,18 @@
+batgrl.gadgets.behaviors.button\_behavior
+=========================================
+
+.. automodule:: batgrl.gadgets.behaviors.button_behavior
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      ButtonState
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ButtonBehavior
+
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.focusable.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.focusable.rst.txt
@@ -0,0 +1,13 @@
+batgrl.gadgets.behaviors.focusable
+==================================
+
+.. automodule:: batgrl.gadgets.behaviors.focusable
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AnyFocusedProperty
+      Focusable
+
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.grabbable.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.grabbable.rst.txt
@@ -0,0 +1,12 @@
+batgrl.gadgets.behaviors.grabbable
+==================================
+
+.. automodule:: batgrl.gadgets.behaviors.grabbable
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Grabbable
+
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.movable.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.movable.rst.txt
@@ -0,0 +1,12 @@
+batgrl.gadgets.behaviors.movable
+================================
+
+.. automodule:: batgrl.gadgets.behaviors.movable
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Movable
+
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.movable_children.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.movable_children.rst.txt
@@ -0,0 +1,12 @@
+batgrl.gadgets.behaviors.movable\_children
+==========================================
+
+.. automodule:: batgrl.gadgets.behaviors.movable_children
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MovableChildren
+
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.rst.txt
@@ -0,0 +1,19 @@
+batgrl.gadgets.behaviors
+========================
+
+.. automodule:: batgrl.gadgets.behaviors
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   button_behavior
+   focusable
+   grabbable
+   movable
+   movable_children
+   themable
+   toggle_button_behavior
diff --git a/_sources/reference/generated/batgrl.gadgets.behaviors.themable.rst.txt b/_sources/reference/generated/batgrl.gadgets.behaviors.themable.rst.txt
@@ -0,0 +1,14 @@
+batgrl.gadgets.behaviors.themable
+=================================
+
+.. automodule:: batgrl.gadgets.behaviors.themable
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Themable
+      _ColorPair
+      _ColorTheme
+
diff --git a/...ces/reference/generated/batgrl.gadgets.behaviors.toggle_button_behavior.rst.txt b/...ces/reference/generated/batgrl.gadgets.behaviors.toggle_button_behavior.rst.txt
@@ -0,0 +1,18 @@
+batgrl.gadgets.behaviors.toggle\_button\_behavior
+=================================================
+
+.. automodule:: batgrl.gadgets.behaviors.toggle_button_behavior
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      ToggleState
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ToggleButtonBehavior
+