Update docs: filter page

Author: LeanderCS

Dockerfile

@@ -11,3 +11,6 @@ COPY requirements.txt /app
 RUN pip install --no-cache-dir -r requirements.txt
 
 COPY . /app
+
+COPY scripts /usr/local/bin
+RUN find /usr/local/bin -type f -name "*" -exec chmod +x {} \;

docs/_static/style.css

@@ -0,0 +1,30 @@
+.wy-side-nav-search {
+    margin: 0;
+}
+.wy-menu-vertical {
+    a, a:visited {
+        color: #d9d9d9;
+    }
+}
+
+.wy-nav-content {
+    max-width: unset;
+
+    a:visited {
+        color: #2980b9;
+    }
+
+    .wy-breadcrumbs-aside {
+        display: none;
+    }
+
+    .document {
+        max-width: 900px;
+    }
+}
+
+footer {
+    .rst-footer-buttons {
+        display: none;
+    }
+}

docs/changelog.rst

@@ -5,15 +5,15 @@ All notable changes to this project will be documented in this file.
 
 
 [0.0.10] - 2025-03-06
---------------------
+---------------------
 
 Added
 ^^^^^
 - Added python 3.14 support.
 
 Changed
 ^^^^^^^
-- Use ``FieldModel`` vor field definition. (Only internal change, no impact on the user)
+- Use ``FieldModel`` for field definition. (Only internal change, no impact on usage)
 
 
 [0.0.9.1] - 2025-02-09
@@ -29,7 +29,7 @@ Changed
 
 Added
 ^^^^^
-- New ``copy`` functionality to copy the value of another field. `Check it out <options/copy>`_
+- New ``copy`` functionality to copy the value of another field. :doc:`Check it out <options/copy>`
 
 Filter
 """"""
@@ -117,16 +117,16 @@ Removed
 
 Added
 ^^^^^
-- New ``condition`` functionality between fields. `Check it out <options/condition>`_
+- New ``condition`` functionality between fields. :doc:`Check it out <options/condition>`
 
 Changed
 ^^^^^^^
-- Switched ``external_api`` config from dict to class. `Check it out <options/external_api#Configuration>`_
+- Switched ``external_api`` config from dict to class. :doc:`Check it out <options/external_api>`
 
 
 [0.0.4] - 2025-01-09
 --------------------
 
 Added
 ^^^^^
-- New external API functionality. `Check it out <options/external_api>`_
+- New external API functionality. :doc:`Check it out <options/external_api>`

docs/conf.py

@@ -3,10 +3,12 @@
 author = "Leander Cain Slotosch"
 release = "0.0.10"
 
-extensions = []
+extensions = ["sphinx_rtd_theme"]
 
 templates_path = []
 exclude_patterns = []
 
-html_theme = "alabaster"
-html_static_path = []
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_css_files = ["style.css"]
+html_theme_options = {"navigation_depth": 4}

docs/development.rst

@@ -1,6 +1,10 @@
 Development
 ===========
 
+This guide will help you set up a development environment for the library project.
+
+You can find the source code for the library in the `GitHub repository <https://github.com/LeanderCS/flask-inputfilter>`_.
+
 Build docker image
 -------------------
 
@@ -31,6 +35,4 @@ Run linting
 
 .. code-block:: bash
 
-    docker exec -it flask-inputfilter sh -c "isort ."
-    docker exec -it flask-inputfilter sh -c "autoflake --in-place --remove-all-unused-imports --ignore-init-module-imports --recursive ."
-    docker exec -it flask-inputfilter black .
+    docker exec -it flask-inputfilter lint

docs/guides/create_own.rst docs/guides/create_own_components.rstdocs/guides/create_own.rst renamed to docs/guides/create_own_components.rst

@@ -1,5 +1,5 @@
-Create own
-===========
+Create own components
+=====================
 
 Depending on what you want to build your own version from, there are different
 parameters and return values required to work properly.

docs/guides/index.rst

@@ -5,4 +5,4 @@ Guides
     :maxdepth: 2
     :glob:
 
-    create_own
+    create_own_components

docs/index.rst

@@ -20,24 +20,15 @@ Available functions:
 - :doc:`Conditions <options/condition>`
 - :doc:`Filter <options/filter>`
 - :doc:`Validator <options/validator>`
-- :doc:`Creating your own Conditions, Filters and Validators <guides/create_own>`
+- :doc:`Creating your own Conditions, Filters and Validators <guides/create_own_components>`
 - :doc:`ExternalApi <options/external_api>`
 
+.. tip::
 
-.. raw:: html
-
-    <div style="border:1px solid #86989B;padding:1rem;border-radius:3px;margin-top:40px;">
-        <p style="background-color:hsl(219.5, 84%, 90%);margin:-1rem -1rem 0.8rem -1rem;padding:0.3rem 1rem 0.3rem 2.5rem;position:relative;border-radius:3px 3px 0 0;">
-            <span style="content:'';position:absolute;top:.25rem;left:.5rem;width:1.5rem;height:1.5rem;background-color:hsl(219.5, 84%, 50%);mask-image:url('data:image/svg+xml;charset=utf-8,<svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 24 24&quot;><path d=&quot;M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z&quot;/></svg>');"></span>
-            Tip
-        </p>
-        <p style="margin:0;">
-            Thank you for using <code>flask-inputfilter</code>!<br>
-            If you have any questions or suggestions, please feel free to open an issue on <a href="https://github.com/LeanderCS/flask-inputfilter">GitHub</a>.<br>
-            If you don't want to miss any updates, please star the repository.<br>
-            This will help me to understand how many people are interested in this project.<br>
-        </p>
-    </div>
+    Thank you for using `flask-inputfilter`!
+    If you have any questions or suggestions, please feel free to open an issue on `GitHub <https://github.com/LeanderCS/flask-inputfilter>`_.
+    If you don't want to miss any updates, please star the repository.
+    This will help me to understand how many people are interested in this project.
 
 Installation
 ------------
@@ -52,7 +43,7 @@ Quickstart
 To use the `InputFilter` class, create a new class that inherits from it and define the
 fields you want to validate and filter.
 
-There are numerous filters and validators available, but you can also create your :doc:`own <guides/create_own>`.
+There are numerous filters and validators available, but you can also create your :doc:`own <guides/create_own_components>`.
 
 Definition
 ^^^^^^^^^^

docs/options/condition.rst

@@ -1,15 +1,15 @@
 Condition
 =========
 
-The `Condition` module contains the conditions that can be used to validate the input data.
+``Conditions`` are used to validate the input data based on rules between fields.
 
-Conditions
-----------
+Overview
+--------
 
 The `addCondition` method is used to add a condition between fields.
 
-Example
--------
+Examples
+--------
 
 .. code-block:: python
 

docs/options/copy.rst

@@ -47,3 +47,37 @@ Basic Copy Integration
 
         # Cotains the same value as username but escaped eg. "very-important-user"
         print(validated_data["escapedUsername"])
+
+
+The coping can also be used as a chain.
+
+.. code-block:: python
+
+    from flask_inputfilter import InputFilter
+    from flask_inputfilter.Filter import SlugifyFilter, ToUpperFilter, ToLowerFilter
+
+    class MyInputFilter(InputFilter):
+        def __init__(self):
+            super().__init__()
+
+            self.add(
+                "username"
+            )
+
+            self.add(
+                "escapedUsername",
+                copy="username"
+                filters=[SlugifyFilter()]
+            )
+
+            self.add(
+                "upperEscapedUsername",
+                copy="escapedUsername"
+                filters=[ToUpperFilter()]
+            )
+
+            self.add(
+                "lowerEscapedUsername",
+                copy="escapedUsername"
+                filters=[ToLowerFilter()]
+            )