add filter doc source

Author: cmeissner

.vscode/settings.json

@@ -1,8 +1,11 @@
 {
-    "python.pythonPath": "${workspaceFolder}/venv/bin/python3",
+    "python.pythonPath": "venv/bin/python",
     "python.autoComplete.extraPaths": ["./tests/scripts"],
     "python.envFile": "${workspaceFolder}/.env",
     "python.linting.flake8Enabled": true,
     "python.linting.enabled": true,
-    "restructuredtext.confPath": "${workspaceFolder}/docs"
+    "restructuredtext.confPath": "${workspaceFolder}/docs",
+    "python.analysis.extraPaths": [
+        "./tests/scripts"
+    ]
 }

docs/filters.rst

@@ -0,0 +1,13 @@
+Filters
+=======
+
+Filters are used to manipulate data if needed.
+
+is_subnet
+---------
+
+This filter checks wether a given subnet belongs to the second one. It returns `true` if first subnet belongs to second and `false` if not or both subnets are the same.
+
+.. code-block:: yaml
+
+   192.0.2.0/25 | codeaffen.phpipam.is_subnet(192.0.2.0/24)

docs/index.rst

@@ -13,6 +13,7 @@ Welcome to phpIPAM Ansible Module documentation!
    README
    Changelog <CHANGELOG>
    plugins/index
+   Filters <filters>
 
 .. toctree::
    :maxdepth: 2