doc

docs/_build/html/_sources/api_reference.rst.txt

@@ -0,0 +1,35 @@
+API Reference
+=============
+
+Below is the complete reference for Optifik's public API.
+
+
+
+io
+--
+.. automodule:: optifik.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fft
+---
+.. automodule:: optifik.fft
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+minmax
+------
+.. automodule:: optifik.minmax
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scheludko
+---------
+.. automodule:: optifik.scheludko
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/_build/html/_sources/examples.rst.txt

@@ -0,0 +1,34 @@
+Examples
+========
+
+Basic Optimization
+------------------
+
+Here's a simple example using Optifik to solve a quadratic function.
+
+.. code-block:: python
+
+    from optifik import minimize
+
+    def quadratic(x):
+        return (x - 3) ** 2
+
+    result = minimize(quadratic, x0=0)
+    print(result)
+
+Constrained Optimization
+------------------------
+
+.. code-block:: python
+
+    from optifik import minimize
+
+    def objective(x):
+        return x[0] ** 2 + x[1] ** 2
+
+    def constraint(x):
+        return x[0] + x[1] - 1
+
+    result = minimize(objective, x0=[0, 0], constraints=[constraint])
+    print(result)
+

docs/_build/html/_sources/index.rst.txt

@@ -0,0 +1,24 @@
+Optifik Documentation
+=====================
+
+Welcome to the documentation for **Optifik**, a Python library for 
+
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Documentation
+
+   installation
+   api_reference
+   examples
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/_build/html/_sources/installation.rst.txt

@@ -0,0 +1,28 @@
+Installation
+============
+
+You can install Optifik using `pip`:
+
+.. code-block:: bash
+
+    pip install optifik
+
+Alternatively, you can install it from source:
+
+.. code-block:: bash
+
+    git clone https://github.com/yourusername/optifik.git
+    cd optifik
+    pip install -e .
+
+Requirements
+------------
+
+- Python >= 3.8
+- NumPy >= 1.21
+
+Optional for extended functionality:
+
+- SciPy
+- Matplotlib
+