📝🛠️ refactor sphinx document config

sharkutilities · Jul 27, 2024 · 51798b6 · 51798b6
1 parent d427096
commit 51798b6
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 25 deletions.
diff --git a/docs/functions.md b/docs/functions.md
@@ -0,0 +1,10 @@
+# User Defined Functions
+
+<div align = "justify">
+
+```{eval-rst}
+.. automodule:: pandaswizard.functions.collate
+ :members:
+```
+
+</div>
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,8 @@
-<h1 align = "center">pandas-wizard</h1>
+<div align = "center">
+
+# pandas-wizard
+
+</div>
 
 <div align = "justify">
 
@@ -40,9 +44,23 @@ statistics.head()
 
 The above function calculates the 50th percentile, i.e., the median of the feature "A" based on the grouped column "group" from the data frame.
 
+## Brief Overview of Capailities
+
+```{eval-rst}
+.. automodule:: pandaswizard
+```
+
+### User Defined Functions
+
+```{eval-rst}
+.. automodule:: pandaswizard.functions
+```
+
 ```{toctree}
 :hidden:
-modules.md
+aggregate.md
+wrappers.md
+functions.md
 ```
 
 ---

diff --git a/docs/modules.md b/docs/modules.md
diff --git a/pandaswizard/__init__.py b/pandaswizard/__init__.py
@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
 
 """
-Utility Functions, Wrappers for pandas Library
+Utility Functions and/or Wrappers for pandas Library
 
-The :mod:`pdwizard` module includes functions, wrappers and other
+The :mod:`pandaswizard` module includes functions, wrappers and other
 utility functions for `pandas` module. The package is kept simple and
 minimalistic such that external dependencies are reduced. The working
 of the module is divided into the following sections:
 
- * **`pandaswizard.aggregate`**: a set of aggregate functions that
- can be used along with `pd.groupby().agg()` method without
- comprimising functionality.
- * **`pandaswizard.wrappers`**: a set of decorators/wrappers that
- can be used along side a function.
+ * :mod:`pandaswizard.aggregate`: a set of aggregate functions
+ that can be used along with ``pd.groupby().agg({...})`` method
+ without comprimising functionality.
+ * :mod:`pandaswizard.wrappers`: a set of decorators/wrappers
+ that can be used along side a function.
 """
 
 # ? package follows https://peps.python.org/pep-0440/

diff --git a/pandaswizard/wrappers.py b/pandaswizard/wrappers.py
@@ -104,8 +104,9 @@ def timeit(func : callable) -> callable:
  executed time of a function, or like the one from command line:
 
  .. code-block:: shell
+
  python -m timeit "function()"
- 
+
  The function is built specifically to handle functions which
  returns a :attr:`pd.DataFrame` object, thus it prints more
  information like the number of records fetched, shape and other