docs boilerplate

2025-10-03 08:41:55 +00:00 · 2025-01-14 17:34:51 +00:00
parent 98f53c750d
commit 8a2fd9cda9
2 changed files with 30 additions and 0 deletions
--- a/docs/source/api_inline_array.rst
+++ b/docs/source/api_inline_array.rst
@@ -66,6 +66,7 @@ Follow the :doc:`build` documentation for this
   ivec4
   color
   plane
+   perlin
   project
   util
   io
--- a/docs/source/perlin.rst
+++ b/docs/source/perlin.rst
@@ -0,0 +1,29 @@
+.. default-domain:: C
+
+perlin
+================================================================================
+
+Header: cglm/perlin.h
+
+Classic Perlin noise implementation.
+
+Table of contents (click to go):
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Functions:
+
+1. :c:func:`glm_perlin`
+
+
+Functions documentation
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. c:function:: float  glm_perlin(vec4 point)
+
+    | Classic Perlin noise
+
+    Parameters:
+      | *[in]*  **point**  4D point
+
+    Returns:
+      | noise value