Merge pull request #14 from CrispenGari/rtd

Rtd

.readthedocs.yaml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "esbonio.sphinx.confDir": ""
+}

README.md

@@ -80,7 +80,7 @@
       - [Guidelines for Safe Usage](#guidelines-for-safe-usage)
 - [Ordering](#ordering)
 - [Filters](#filters)
-    - [Operators](#operators)
+  - [Operators](#operators)
 - [Data Aggregation](#data-aggregation)
   - [Aggregation Functions](#aggregation-functions)
 - [Utilities](#utilities)
@@ -485,14 +485,15 @@ class Post(Model):
 ```
 
 The following are the arguments that the `PrimaryKeyColumn` class accepts.
-| Argument | Description | Type | Default |
-| ---------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------- | ------------- |
-| `type` | The datatype of your primary key. | `str` | `"int`" |
-| `length` | Optional to specify the length of the type. If passed as `N` with type `T`, it yields an SQL statement with type `T(N)`. | `int` \| `None` | `None` |
-| `auto_increment`| Optional to specify if the column will automatically increment or not. |`bool` |`False` |
-|`default` | Optional to specify the default value in a column. |`any` |`None` |
-|`nullable` | Optional to specify if the column will allow null values or not. |`bool` |`False` |
-|`unique` | Optional to specify if the column will contain unique values or not. |`bool` |`True` |
+
+| Argument         | Description                                                                                                              | Type            | Default |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------- | ------- |
+| `type`           | The datatype of your primary key.                                                                                        | `str`           | `"int`" |
+| `length`         | Optional to specify the length of the type. If passed as `N` with type `T`, it yields an SQL statement with type `T(N)`. | `int` \| `None` | `None`  |
+| `auto_increment` | Optional to specify if the column will automatically increment or not.                                                   | `bool`          | `False` |
+| `default`        | Optional to specify the default value in a column.                                                                       | `any`           | `None`  |
+| `nullable`       | Optional to specify if the column will allow null values or not.                                                         | `bool`          | `False` |
+| `unique`         | Optional to specify if the column will contain unique values or not.                                                     | `bool`          | `True`  |
 
 #### `ForeignKeyColumn` Class
 
@@ -703,7 +704,7 @@ Returns a `conn` and the list of `tablenames` that exist in the database. The me
 
 ### CRUD Operations with Dataloom
 
-In this section of the documentation, we will illustrate how to perform basic `CRUD` operations using `dataloom` on simple `Models`. Please note that in the following code snippets, I will be utilizing `sqlite_loom`. However, it's important to highlight that you can use any `loom` of your choice to follow along.
+In this section of the documentation, we will illustrate how to perform basic `CRUD` operations using `dataloom` on simple `Models`. Please note that in the following code snippets, I will be utilizing `sqlite_loom`, `mysql_loom`, `pg_loom` or `loom` interchangeably. However, it's important to highlight that you can use any `loom` of your choice to follow along.
 
 #### 1. Creating a Record
 
@@ -845,7 +846,7 @@ The `find_many()` method takes in the following arguments:
 
 ##### 3. `find_one()`
 
-Here is an example showing you how you can use `find_by_pk()` locate a single record in the database.
+Here is an example showing you how you can use `find_one()` locate a single record in the database.
 
 ```py
 user = mysql_loom.find_one(
@@ -1039,8 +1040,11 @@ To mitigate the potential risks associated with `delete_bulk()`, follow these gu
    - When calling `delete_bulk()`, make sure to provide a filter to specify the subset of records to be deleted. This helps prevent unintentional deletions.
 
    ```python
-   # Example: Delete records where 'status' is 'inactive'
-   sqlite_loom.delete_bulk(filter={'status': 'inactive'})
+    # Example: Delete records where 'status' is 'inactive'
+    affected_rows = mysql_loom.delete_bulk(
+        instance=User,
+        filters=Filter(column="status",  value='inactive'),
+    )
    ```
 
 2. **Consider Usage When Necessary:**

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,4 @@
+# Defining the exact version will make sure things don't break
+sphinx==5.3.0
+sphinx_rtd_theme==1.1.1
+readthedocs-sphinx-search==0.1.1

docs/source/_static/css/index.css

@@ -0,0 +1,3 @@
+table.my-table td {
+  white-space: normal !important;
+}