Documentation update

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9a42404eea90903facc3b43a7a9b8b94
+config: 38796db92814ccc3fb85c6323937f8f5
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_modules/index.html

@@ -129,6 +129,13 @@
 <nav>
   <ul class="bd-navbar-elements navbar-nav">
 
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../introduction.html">
+    Introduction
+  </a>
+</li>
+
+
 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../modules.html">
     ragoon
@@ -137,25 +144,61 @@
 
 
 <li class="nav-item ">
-  <a class="nav-link nav-internal" href="../ragoon.html">
-    ragoon package
+  <a class="nav-link nav-internal" href="../api_reference.html">
+    API Reference
   </a>
 </li>
 
 
 <li class="nav-item ">
-  <a class="nav-link nav-external" href="https://github.com/louisbrulenaudet">
-    GitHub
+  <a class="nav-link nav-internal" href="../autosummary/ragoon.html">
+    ragoon
   </a>
 </li>
 
 
 <li class="nav-item ">
-  <a class="nav-link nav-external" href="https://x.com/louisbrulenaudet">
+  <a class="nav-link nav-internal" href="../autosummary/ragoon.embeddings.html">
+    ragoon.embeddings
+  </a>
+</li>
+
+            <li class="nav-item dropdown">
+                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
+                    More
+                </button>
+                <ul id="pst-nav-more-links" class="dropdown-menu">
+
+<li class=" ">
+  <a class="nav-link dropdown-item nav-internal" href="../autosummary/ragoon.similarity_search.html">
+    ragoon.similarity_search
+  </a>
+</li>
+
+
+<li class=" ">
+  <a class="nav-link dropdown-item nav-internal" href="../autosummary/ragoon.web_rag.html">
+    ragoon.web_rag
+  </a>
+</li>
+
+
+<li class=" ">
+  <a class="nav-link dropdown-item nav-external" href="https://github.com/louisbrulenaudet">
+    GitHub
+  </a>
+</li>
+
+
+<li class=" ">
+  <a class="nav-link dropdown-item nav-external" href="https://x.com/louisbrulenaudet">
     Twitter
   </a>
 </li>
 
+                </ul>
+            </li>
+
   </ul>
 </nav></div>
 
@@ -238,6 +281,13 @@
 <nav>
   <ul class="bd-navbar-elements navbar-nav">
 
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../introduction.html">
+    Introduction
+  </a>
+</li>
+
+
 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../modules.html">
     ragoon
@@ -246,8 +296,36 @@
 
 
 <li class="nav-item ">
-  <a class="nav-link nav-internal" href="../ragoon.html">
-    ragoon package
+  <a class="nav-link nav-internal" href="../api_reference.html">
+    API Reference
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../autosummary/ragoon.html">
+    ragoon
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../autosummary/ragoon.embeddings.html">
+    ragoon.embeddings
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../autosummary/ragoon.similarity_search.html">
+    ragoon.similarity_search
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../autosummary/ragoon.web_rag.html">
+    ragoon.web_rag
   </a>
 </li>
 

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

@@ -0,0 +1,13 @@
+API Reference
+=============
+
+This section provides the API reference for the RAGoon project.
+
+.. autosummary::
+   :toctree: autosummary
+   :recursive:
+
+   ragoon
+   ragoon.embeddings
+   ragoon.similarity_search
+   ragoon.web_rag

docs/build/html/_sources/autosummary/modules.rst.txt

@@ -0,0 +1,7 @@
+ragoon
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   ragoon

docs/build/html/_sources/autosummary/ragoon.embeddings.rst.txt

@@ -0,0 +1,13 @@
+ragoon.embeddings
+=================
+
+.. automodule:: ragoon.embeddings
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      EmbeddingsDataLoader
+      EmbeddingsVisualizer
+

docs/build/html/_sources/autosummary/ragoon.rst.txt

@@ -0,0 +1,15 @@
+ragoon
+======
+
+.. automodule:: ragoon
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   embeddings
+   similarity_search
+   web_rag

docs/build/html/_sources/autosummary/ragoon.similarity_search.rst.txt

@@ -0,0 +1,12 @@
+ragoon.similarity\_search
+=========================
+
+.. automodule:: ragoon.similarity_search
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      SimilaritySearch
+

docs/build/html/_sources/autosummary/ragoon.web_rag.rst.txt

@@ -0,0 +1,12 @@
+ragoon.web\_rag
+===============
+
+.. automodule:: ragoon.web_rag
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      WebRAG
+

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

@@ -10,11 +10,20 @@ Contents:
 
 .. toctree::
    :maxdepth: 2
-   :caption: Modules:
+   :caption: Contents:
 
+   introduction
    modules
    api_reference
+
+.. autosummary::
+   :toctree: autosummary
+   :recursive:
+
    ragoon
+   ragoon.embeddings
+   ragoon.similarity_search
+   ragoon.web_rag
 
 Indices and tables
 ==================

docs/build/html/_sources/introduction.rst.txt

@@ -0,0 +1,8 @@
+Introduction
+============
+
+Welcome to the RAGoon documentation. This section provides an overview of the project.
+
+.. contents:: Table of Contents
+   :local:
+   :depth: 2