Merge pull request #24 from LeanderCS/23

23 | Add documentary

Author: LeanderCS

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,46 @@
+name: Deploy Sphinx Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: github-pages
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install Dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme
+
+      - name: Build Documentation
+        run: |
+          sphinx-build -b html docs/ _build
+
+      - name: Upload artifacts
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _build
+          name: github-pages
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          artifact_name: github-pages
+          preview: false

.github/workflows/test_env.yaml

@@ -18,7 +18,7 @@ jobs:
         uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-docker-flask-inputfilter-env-${{ hashFiles('Dockerfile') }}
+          key: ${{ runner.os }}-docker-flask-inputfilter-env-${{ hashFiles('env_configs/Dockerfile') }}
           restore-keys: |
             ${{ runner.os }}-docker-flask-inputfilter-env-
 

.gitignore

@@ -157,3 +157,4 @@ cython_debug/
 .idea/
 .vscode/
 .DS_Store
+_build

CHAGELOG.md

@@ -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)

CREATE_OWN.md

@@ -1,10 +1,20 @@
 flask-inputfilter
-==================================
+=================
 
-The `InputFilter` class is used to validate and filter input data in Flask applications.
+The ``InputFilter`` class is used to validate and filter input data in Flask applications.
 It provides a modular way to clean and ensure that incoming data meets expected format
 and type requirements before being processed.
 
+Thank you for using `flask-inputfilter`!
+========================================
+
+Thank you for using ``flask-inputfilter``!
+If you have any questions or suggestions, please feel free to open an issue on GitHub `here <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.
+
+========================================
+
 :Test Status:
 
     .. image:: https://img.shields.io/github/actions/workflow/status/LeanderCS/flask-inputfilter/test.yaml?branch=main&style=flat-square&label=Github%20Actions
@@ -37,10 +47,10 @@ Installation
 Quickstart
 ==========
 
-To use the `InputFilter` class, create a new class that inherits from it and define the
+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 `own <CREATE_OWN.md>`_.
+There are numerous filters and validators available, but you can also create your `own <https://leandercs.github.io/flask-inputfilter/guides/create_own.html>`_.
 
 Definition
 ----------
@@ -92,8 +102,8 @@ Definition
 Usage
 -----
 
-To use the `InputFilter` class, call the `validate` method on the class instance.
-After calling `validate`, the validated data will be available in `g.validated_data`.
+To use the ``InputFilter`` class, call the ``validate`` method on the class instance.
+After calling ``validate``, the validated data will be available in ``g.validated_data``.
 If the data is invalid, a 400 response with an error message will be returned.
 
 .. code-block:: python
@@ -112,33 +122,11 @@ If the data is invalid, a 400 response with an error message will be returned.
         id = data.get('id')
         zipcode = data.get('zipcode')
 
-Options
-=======
-
-The `add` method supports several options:
-
-- `Required`_
-- `Filter <flask_inputfilter/Filter/README.md>`_
-- `Validator <flask_inputfilter/Validator/README.md>`_
-- `Default`_
-- `Fallback`_
-- `ExternalApi <EXTERNAL_API.md>`_
-
-Required
---------
-
-The `required` option specifies whether the field must be included in the input data.
-If the field is missing, a `ValidationError` will be raised with an appropriate error message.
 
-Default
--------
 
-The `default` option allows you to specify a default value to use if the field is not
-present in the input data.
+See also
+========
 
-Fallback
---------
+For further instructions please view the documentary `Here <https://github.com/LeanderCS/flask-inputfilter>`_.
+For ideas, suggestions or questions, please open an issue on GitHub `here <https://github.com/LeanderCS/flask-inputfilter>`_.
 
-The `fallback` option specifies a value to use if validation fails or required data
-is missing. Note that if the field is optional and absent, `fallback` will not apply;
-use `default` in such cases.