update docs

Author: debpal

docs/changelog.rst

@@ -2,6 +2,14 @@
 Release Notes
 ===============
 
+Version 0.0.3
+---------------
+
+* **Release date:** 23-Oct-2024.
+
+* **Features:** Introduced enhanced functionality for GIS file operations. The :class:`GeoAnalyze.File` class has now reached a stable and mature stage.
+
+
 Version 0.0.2
 ---------------
 

docs/conf.py

@@ -1,6 +1,6 @@
 import os
 import sys
-import sphinx_rtd_theme
+
 if os.path.abspath('..') in sys.path:
     pass
 else:
@@ -37,10 +37,6 @@
 
 html_theme = 'sphinx_rtd_theme'
 
-html_theme_path = [
-    sphinx_rtd_theme.get_html_theme_path()
-]
-
 html_static_path = [
     '_static'
 ]

docs/introduction.rst

@@ -1,12 +1,19 @@
-=============
+==============
 Introduction
-=============
+==============    
+    
+GeoAnalyze is a Python package designed to streamline geoprocessing by handling internal complexities and intermediate steps. Conceptualized and launched on October 10, 2024, this package is tailored for users with limited geospatial processing experience, allowing them to focus on desired outputs. The package is still in the planning stage, but active development is ongoing, with exciting new features planned for future releases.
 
+Leveraging open-source geospatial Python modules, GeoAnalyze aims to empower users by providing high-level geoprocessing tools with fewer lines of code.
 
-GeoAnalyze is a Python package designed to streamline geoprocessing by handling internal complexities and intermediate steps. Conceptualized and launched on October 10, 2024, this package is tailored for users with limited geocoding experience, focusing on desired outputs. Active development is ongoing, with exciting new features planned for future releases. Leveraging open-source geospatial modules of Python, the goal of GeoAnalyze is to empower users by providing high-level geoprocessing tools with fewer lines of code. Currently, the package is in the planning stage and offers the following file operation features for testing purposes:
 
+File Operations (Irrespective of Extensions)
+----------------------------------------------
 
-* **File operations**
+When managing GIS files, each main file is often associated with several auxiliary files. For example, a `.shp` file (shapefile) is commonly accompanied by `.cpg`, `.dbf`, `.prj`, and `.shx` files, which are necessary for the shapefile to function correctly. In geospatial processing, these associated files must be handled together to prevent errors or data loss. GeoAnalyze simplifies this process by ensuring that any operation performed on a main file automatically includes its associated auxiliary files, making file management seamless and error-free. The package offers the following file operation features:
 
-    - Deleting files of the same name in a folder, irrespective of extensions.
-    - Transferring files of the same name, irrespective of extensions, from the source folder to the destination folder.
+* Deleting files in a folder.
+* Transferring files from the source folder to the destination folder.
+* Renaming files in a folder.
+* Copying files from the source folder and renames them in the destination folder.
+* Extracting files with the same extension from a folder.

docs/quickstart.rst

@@ -2,34 +2,70 @@
 Quickstart
 ============
 
-This guide provides a quick overview to get started with :mod:`GeoAnalyze`.
+This guide provides a quick overview to help you get started with the :mod:`GeoAnalyze`.
 
 
 Verify Installation
 ---------------------
-Ensure successful installation by running the following commands:
+
+To verify installation, import the module and initialize the :class:`GeoAnalyze.File` class using the following code. If no errors are raised, the installation has been successful.
+
 
 .. code-block:: python
 
     import GeoAnalyze
     file = GeoAnalyze.file()
     
     
-Delete File
--------------
-Deleting files with the same name in a folder, irrespective of extensions, if the file exists.
+Performing File Operations
+----------------------------
+
+In geospatial processing, a shapefile such as `original.shp` typically has associated files like `original.cpg`, `original.dbf`, `original.prj`, and `original.shx`. These files are critical for the shapefile to function properly. Below are examples of common file operations that can be performed on a shapefile and its associated files.
+    
+
+Renaming Files
+^^^^^^^^^^^^^^^^
+
+To rename `original.shp` and its associated files, you can use the following code. This ensures that all related files are renamed consistently.
 
 .. code-block:: python
 
-    file.delete_by_name(
+    file.name_change(
         folder_path=r"C:\Users\Username\Folder",
-        file_names=['test']
+        rename_map={'original': 'rename'}
     )
     
-Expected output:
+    
+    
+Transferring Files
+^^^^^^^^^^^^^^^^^^^^
+
+To move the renamed shapefile `rename.shp` and its associated files from the source folder to the destination folder, the following code can be used. This will ensure the specified files are transferred correctly based on the provided names.
 
-.. code-block:: text
+.. code-block:: python
+
+    file.transfer_by_name(
+        src_folder=r"C:\Users\Username\SRC_Folder",
+        dst_folder=r"C:\Users\Username\DST_Folder",
+        file_names=['rename']
+    )
+    
+    
+Deleting files
+^^^^^^^^^^^^^^^^^
+
+To delete the shapefile `rename.shp` and all its associated files from a folder, use the following code.
+
+.. code-block:: python
+
+    file.delete_by_name(
+        folder_path=r"C:\Users\Username\DST_Folder",
+        file_names=['rename']
+    )
+
+
+    
+    
 
-    "List of deleted files: ['test.cpg', 'test.dbf', 'test.prj', 'test.shp', 'test.shx']."