update to docs

FNBBDevs · Nov 11, 2024 · 3f19f5a · 3f19f5a
1 parent 37dd7d1
commit 3f19f5a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/source/bruheffect/fire_effect.rst 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
@@ -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