python-validators
diff --git a/‎.github/workflows/docs.yaml.bkp
+5-5 b/‎.github/workflows/docs.yaml.bkp
+5-5
diff --git a/‎.github/workflows/package.yaml renamed to ‎.github/workflows/package.yaml.bkp
+3-3 b/‎.github/workflows/package.yaml renamed to ‎.github/workflows/package.yaml.bkp
+3-3
diff --git a/‎.github/workflows/pycqa.yaml
+4-4 b/‎.github/workflows/pycqa.yaml
+4-4
diff --git a/‎.github/workflows/sast.yaml
+1-1 b/‎.github/workflows/sast.yaml
+1-1
diff --git a/‎.gitignore
-4 b/‎.gitignore
-4
diff --git a/‎CHANGES.md
+20-3 b/‎CHANGES.md
+20-3
diff --git a/‎MANIFEST.in
+14-4 b/‎MANIFEST.in
+14-4
diff --git a/‎SECURITY.md
+1-1 b/‎SECURITY.md
+1-1
diff --git a/‎docs/references/between.md renamed to ‎docs/api/between.md b/‎docs/references/between.md renamed to ‎docs/api/between.md
diff --git a/‎docs/api/between.rst
+5 b/‎docs/api/between.rst
+5
diff --git a/‎docs/references/btc_address.md renamed to ‎docs/api/btc_address.md b/‎docs/references/btc_address.md renamed to ‎docs/api/btc_address.md
diff --git a/‎docs/api/btc_address.rst
+5 b/‎docs/api/btc_address.rst
+5
diff --git a/‎docs/references/card.md renamed to ‎docs/api/card.md b/‎docs/references/card.md renamed to ‎docs/api/card.md
diff --git a/‎docs/api/card.rst
+12 b/‎docs/api/card.rst
+12
diff --git a/‎docs/references/country_code.md renamed to ‎docs/api/country_code.md b/‎docs/references/country_code.md renamed to ‎docs/api/country_code.md
diff --git a/‎docs/api/country_code.rst
+5 b/‎docs/api/country_code.rst
+5
diff --git a/‎docs/references/domain.md renamed to ‎docs/api/domain.md b/‎docs/references/domain.md renamed to ‎docs/api/domain.md
diff --git a/‎docs/api/domain.rst
+5 b/‎docs/api/domain.rst
+5
diff --git a/‎docs/references/email.md renamed to ‎docs/api/email.md b/‎docs/references/email.md renamed to ‎docs/api/email.md
diff --git a/‎docs/api/email.rst
+5 b/‎docs/api/email.rst
+5
diff --git a/‎docs/references/hashes.md renamed to ‎docs/api/hashes.md b/‎docs/references/hashes.md renamed to ‎docs/api/hashes.md
diff --git a/‎docs/api/hashes.rst
+9 b/‎docs/api/hashes.rst
+9
diff --git a/‎docs/references/hostname.md renamed to ‎docs/api/hostname.md b/‎docs/references/hostname.md renamed to ‎docs/api/hostname.md
diff --git a/‎docs/api/hostname.rst
+5 b/‎docs/api/hostname.rst
+5
diff --git a/‎docs/references/i18n.md renamed to ‎docs/api/i18n.md b/‎docs/references/i18n.md renamed to ‎docs/api/i18n.md
diff --git a/‎docs/api/i18n.rst
+12 b/‎docs/api/i18n.rst
+12
diff --git a/‎docs/references/iban.md renamed to ‎docs/api/iban.md b/‎docs/references/iban.md renamed to ‎docs/api/iban.md
diff --git a/‎docs/api/iban.rst
+5 b/‎docs/api/iban.rst
+5
diff --git a/‎docs/references/ip_address.md renamed to ‎docs/api/ip_address.md b/‎docs/references/ip_address.md renamed to ‎docs/api/ip_address.md
diff --git a/‎docs/api/ip_address.rst
+6 b/‎docs/api/ip_address.rst
+6
diff --git a/‎docs/references/length.md renamed to ‎docs/api/length.md b/‎docs/references/length.md renamed to ‎docs/api/length.md
diff --git a/‎docs/api/length.rst
+5 b/‎docs/api/length.rst
+5
diff --git a/‎docs/references/mac_address.md renamed to ‎docs/api/mac_address.md b/‎docs/references/mac_address.md renamed to ‎docs/api/mac_address.md
diff --git a/‎docs/api/mac_address.rst
+5 b/‎docs/api/mac_address.rst
+5
diff --git a/‎docs/references/slug.md renamed to ‎docs/api/slug.md b/‎docs/references/slug.md renamed to ‎docs/api/slug.md
diff --git a/‎docs/api/slug.rst
+5 b/‎docs/api/slug.rst
+5
diff --git a/‎docs/references/url.md renamed to ‎docs/api/url.md b/‎docs/references/url.md renamed to ‎docs/api/url.md
diff --git a/‎docs/api/url.rst
+5 b/‎docs/api/url.rst
+5
diff --git a/‎docs/references/utils.md renamed to ‎docs/api/utils.md b/‎docs/references/utils.md renamed to ‎docs/api/utils.md
diff --git a/‎docs/api/utils.rst
+6 b/‎docs/api/utils.rst
+6
diff --git a/‎docs/references/uuid.md renamed to ‎docs/api/uuid.md b/‎docs/references/uuid.md renamed to ‎docs/api/uuid.md
diff --git a/‎docs/api/uuid.rst
+5 b/‎docs/api/uuid.rst
+5
diff --git a/‎docs/conf.py
+1-1 b/‎docs/conf.py
+1-1
diff --git a/‎docs/index.rst
+69 b/‎docs/index.rst
+69
@@ -15,10 +15,10 @@ jobs:
     steps:
       # checkout repository
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v3.12
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.12"
       # building
@@ -30,10 +30,10 @@ jobs:
         run: python package/export docs
       # set up Pages
       - name: Set up Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
       # upload static page
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ${{ env.BUILD_PATH }}/site
   deploy:
@@ -50,4 +50,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4
@@ -16,10 +16,10 @@ jobs:
     steps:
       # checkout repository
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v3.8
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.8"
       # install dependencies
@@ -38,7 +38,7 @@ jobs:
           deactivate
       # upload package as artifact
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ${{ env.BUILD_PATH }}/dist
   publish:
 
@@ -14,10 +14,10 @@ jobs:
     steps:
       # checkout repository
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v3.8
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.8"
       # tooling
@@ -41,10 +41,10 @@ jobs:
       # checkout repository again!
       # ref: https://github.com/actions/checkout/issues/19
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
 
@@ -16,7 +16,7 @@ jobs:
       actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Bandit
         uses: mdegis/bandit-action@85fcc340c3b0bf5d86029abb49b9aac916d807b2
         with:
 
@@ -69,11 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-# docs/references/
 docs/_build/
-# temporary
-docs/references/*.rst
-docs/*.rst
 docs/*.1
 
 # PyBuilder
 
@@ -1,21 +1,31 @@
 # MANIFEST.in stays as long as pyproject.toml does not officially support it
 # https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
 
-include docs/*
-include .gitignore
+# include
+include CHANGES.md
+include mkdocs.yaml
+
 
 # global-include
 
+
+# recursive-include
 recursive-include tests *
+recursive-include docs *
+
 
 # graft
 
+
 # exclude
 
+
 # global-exclude
 
-recursive-exclude docs *.rst
-recursive-exclude docs/references *.md
 
+# recursive-exclude
+
+
+# prune
 prune docs/_build
 prune **/__pycache__
@@ -28,7 +28,7 @@
     "sphinx.ext.napoleon",
     "myst_parser",
 ]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "*.md"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/*.md", "*.md"]
 
 
 # -- Options for HTML output -------------------------------------------------
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`"sphinx.ext.napoleon",`
`29`	`29`	`"myst_parser",`
`30`	`30`	`]`
`31`		`-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "*.md"]`
	`31`	`+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "*/.md", "*.md"]`
`32`	`32`
`33`	`33`
`34`	`34`	`# -- Options for HTML output -------------------------------------------------`