From 3f19f5a27d49beb0eecb5bb3e183de65207faf0e Mon Sep 17 00:00:00 2001 From: ethanlchristensen Date: Sun, 10 Nov 2024 19:28:51 -0600 Subject: [PATCH] update to docs --- docs/source/bruheffect/fire_effect.rst | 7 +++++++ docs/source/bruheffect/index.rst | 5 +++++ 2 files changed, 12 insertions(+) create mode 100644 docs/source/bruheffect/fire_effect.rst diff --git a/docs/source/bruheffect/fire_effect.rst b/docs/source/bruheffect/fire_effect.rst new file mode 100644 index 0000000..e43e89d --- /dev/null +++ b/docs/source/bruheffect/fire_effect.rst @@ -0,0 +1,7 @@ +Fire Effect +=========== + +.. automodule:: bruhanimate.bruheffect.fire_effect + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bruheffect/index.rst b/docs/source/bruheffect/index.rst index efc5662..3bebd8b 100644 --- a/docs/source/bruheffect/index.rst +++ b/docs/source/bruheffect/index.rst @@ -27,6 +27,10 @@ Key Modules and Purposes: Focuses on rendering line-based visuals, ideal for creating stylized line art or dynamic geometries. +- **fire_effect** + + Simulates fire burning with the ability to tweak certain parameters to change how the fire burns. + - **firework_effect** Simulates firework displays, offering colorful and explosive visualizations for celebratory animations. @@ -81,6 +85,7 @@ Explore these modules to discover the diverse effects you can achieve with the ` base_effect chatbot_effect draw_lines_effect + fire_effect firework_effect game_of_life_effect matrix_effect