Improving documentation

Author: GaspardMerten

README.md

@@ -43,7 +43,7 @@ Based on the [arXiv preprint](https://arxiv.org/abs/2506.11781), **GeoPandas-AI*
 
 ```bash
 pip install geopandas-ai
-````
+```
 
 Python 3.8+ required.
 

docs/api.md

@@ -1 +1,29 @@
-::: geopandasai
+# API Documentation
+
+## GeoDataFrame AI
+
+::: geodataframe_ai
+
+## Configuration
+
+::: config
+
+## GeoPandas Wrapper
+
+::: wrapper
+
+
+## Services
+
+### Cache Backend
+
+::: external.cache.backend.base
+::: external.cache.backend.file_system
+::: external.cache.backend.in_memory
+
+
+### Code Execution Backend
+
+::: services.code.executor.base
+::: services.code.executor.trusted
+::: services.code.executor.untrusted

docs/getting_started.md

@@ -10,7 +10,7 @@ GeoPandas-AI requires **Python 3.8+**. Install via pip:
 
 ```bash
 pip install geopandas-ai
-````
+```
 
 This will pull in dependencies including GeoPandas and LiteLLM.
 

docs/index.md

@@ -45,7 +45,7 @@ Based on the [arXiv preprint](https://arxiv.org/abs/2506.11781), **GeoPandas-AI*
 
 ```bash
 pip install geopandas-ai
-````
+```
 
 Python 3.8+ required.
 

geopandasai/config.py

@@ -21,6 +21,16 @@
 
 @dataclass(frozen=True, eq=True)
 class GeoPandasAIConfig:
+    """
+    Configuration class for GeoPandasAI.
+
+    This class holds the configuration settings for GeoPandasAI, including
+    the lite LLM configuration, libraries to be used, cache backend,
+    data descriptor, code injector, code executor, and return types.
+    It is designed to be immutable after creation, ensuring that the configuration
+    remains consistent throughout the application.
+    """
+
     lite_llm_config: Optional[dict] = field(
         default_factory=lambda: _load_default_lite_llm_config()
     )

geopandasai/external/cache/backend/base.py

@@ -3,6 +3,13 @@
 
 
 class ACacheBackend(abc.ABC):
+    """
+    Base class for all cache backends.
+    This class defines the interface for caching mechanisms used in GeoPandasAI.
+    It provides methods to get, set, clear, and reset cache entries.
+    Subclasses should implement these methods to provide specific caching functionality.
+    """
+
     def get_cache(self, key: str) -> Optional[bytes]:
         """
         Get the cached result for the given key.

geopandasai/external/cache/backend/file_system.py

@@ -5,6 +5,10 @@
 
 
 class FileSystemCacheBackend(ACacheBackend):
+    """
+    FileSystemCacheBackend is a cache backend that stores cached results in the file system.
+    """
+
     def __init__(self, cache_dir: str = "./.geopandasai_cache"):
         self.cache_dir = cache_dir
         os.makedirs(cache_dir, exist_ok=True)

geopandasai/external/cache/backend/in_memory.py

@@ -4,6 +4,10 @@
 
 
 class InMemoryCacheBackend(ACacheBackend):
+    """
+    InMemoryCacheBackend is a cache backend that stores cached results in memory.
+    """
+
     def __init__(self):
         self.cache = {}
 

geopandasai/services/code/executor/base.py

@@ -5,6 +5,10 @@
 
 
 class ACodeExecutor(abc.ABC):
+    """
+    Abstract base class for executing Python code.
+    """
+
     @abc.abstractmethod
     def execute(self, code: str, return_type: Type, *dfs: Iterable[GeoOrDataFrame]):
         pass

geopandasai/services/code/executor/trusted.py

@@ -7,7 +7,23 @@
 
 
 class TrustedCodeExecutor(ACodeExecutor):
+    """
+    A class for executing trusted Python code in a temporary file.
+
+    This class inherits from `ACodeExecutor` and provides functionality
+    to safely execute Python code passed as a string. It ensures the
+    result matches the expected return type and wraps GeoDataFrame results
+    with `GeoDataFrameAI` for additional functionality.
+    """
+
     def execute(self, code: str, return_type: Type, *dfs: Iterable[GeoOrDataFrame]):
+        """
+        Executes the provided Python code in a temporary file and returns the result.
+        :param code: The Python code to execute as a string.
+        :param return_type: The expected return type of the code execution.
+        :param dfs: An iterable of GeoDataFrame or DataFrame objects to be passed as arguments to the executed code.
+        :return:            The result of the executed code, wrapped in GeoDataFrameAI if it is a GeoDataFrame.
+        """
         with tempfile.NamedTemporaryFile(delete=True, suffix=".py", mode="w") as f:
             f.write(code)
             f.flush()