Merge pull request #99 from FNBBDevs/dev

docs
FNBBDevs · Nov 11, 2024 · 2bca87d · 2bca87d
2 parents f91702e + 2ca6644
commit 2bca87d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/docs/source/bruheffect/index.rst b/docs/source/bruheffect/index.rst
@@ -37,6 +37,10 @@ Key Modules and Purposes:
 
   Emulates Conway's Game of Life, offering a classic cellular automaton effect for use in simulations or educational projects.
 
+- **julia_effect**
+
+  Creates julia fractals to the screen from: https://en.wikipedia.org/wiki/Julia_set.
+
 - **matrix_effect**
 
   Recreates the iconic "Matrix" digital rain effect, perfect for adding a cyberpunk aesthetic to any project.
@@ -86,6 +90,7 @@ Explore these modules to discover the diverse effects you can achieve with the `
    fire_effect
    firework_effect
    game_of_life_effect
+   julia_effect
    matrix_effect
    noise_effect
    offset_effect

diff --git a/docs/source/bruheffect/julia_effect.rst b/docs/source/bruheffect/julia_effect.rst
@@ -0,0 +1,7 @@
+Julia Effect
+============
+
+.. automodule:: bruhanimate.bruheffect.julia_effect
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/demos/index.rst b/docs/source/demos/index.rst
@@ -32,6 +32,10 @@ Key Modules and Purposes:
 
   Offers a collection of festive effects suitable for holiday seasons, enhancing projects with themes of celebration and joy.
 
+- **julia_demo**
+
+  Offers a demo on how to use the JuliaEffect.
+
 - **line_demo**
 
   Demonstrates the creation of line-based graphics, ideal for artistic visualizations and geometric explorations.
@@ -83,6 +87,7 @@ Explore these modules to discover the impressive demonstrations available with t
    firework_demo
    gol_demo
    holiday
+   julia_demo
    line_demo
    matrix_demo
    noise_demo

diff --git a/docs/source/demos/julia_demo.rst b/docs/source/demos/julia_demo.rst
@@ -0,0 +1,7 @@
+Julia Demo
+==========
+
+.. automodule:: bruhanimate.demos.julia_demo
+   :members:
+   :undoc-members:
+   :show-inheritance: