Merge pull request #329 from yozachar/workshop

maint: adds versiond docs; update copyright year
python-validators · Mar 19, 2024 · 464b088 · 464b088
2 parents 3b1b01b + 1f5f499
commit 464b088
Show file tree

Hide file tree

Showing 27 changed files with 148 additions and 12 deletions.
diff --git a/.github/workflows/docs.yaml → .github/workflows/docs.yaml.bkp b/.github/workflows/docs.yaml → .github/workflows/docs.yaml.bkp
diff --git a/.gitignore b/.gitignore
@@ -69,7 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/reference/
+# docs/references/
 docs/_build/
 docs/*.rst
 docs/*.1

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 - 2023 Konsta Vesterinen
+Copyright (c) 2013 - 2024 Konsta Vesterinen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

diff --git a/README.md b/README.md
@@ -18,12 +18,17 @@ True
 
 ## Resources
 
-- [Documentation](https://python-validators.github.io/validators/)
+<!-- Temporary documentation URL :  https://yozachar.github.io/pyvalidators/ -->
+<!-- Original documentation URL :  https://python-validators.github.io/validators/ -->
+
+- [Documentation](https://yozachar.github.io/pyvalidators/)
 - [Bugtracker](https://github.com/python-validators/validators/issues)
 - [Security](https://github.com/python-validators/validators/blob/master/SECURITY.md)
 - [Code](https://github.com/python-validators/validators/)
 
-[//]: #(Links)
+<!-- Original docs URL will be restored, once properly versioned docs is ready. -->
+
+<!-- Links -->
 [sast-badge]: https://github.com/python-validators/validators/actions/workflows/sast.yaml/badge.svg
 [sast-link]: https://github.com/python-validators/validators/actions/workflows/sast.yaml
 [pycqa-badge]: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml/badge.svg

diff --git a/docs/index.md b/docs/index.md
@@ -18,7 +18,7 @@ True
 
 ## Resources
 
-- [Documentation](https://python-validators.github.io/validators/)
+- [Documentation](https://yozachar.github.io/pyvalidators/)
 - [Bugtracker](https://github.com/python-validators/validators/issues)
 - [Security](https://github.com/python-validators/validators/blob/master/SECURITY.md)
 - [Code](https://github.com/python-validators/validators/)

diff --git a/docs/references/between.md b/docs/references/between.md
@@ -0,0 +1,3 @@
+# between
+
+::: validators.between.between
diff --git a/docs/references/btc_address.md b/docs/references/btc_address.md
@@ -0,0 +1,3 @@
+# btc_address
+
+::: validators.btc_address.btc_address
diff --git a/docs/references/card.md b/docs/references/card.md
@@ -0,0 +1,10 @@
+# card
+
+::: validators.card.amex
+::: validators.card.card_number
+::: validators.card.diners
+::: validators.card.discover
+::: validators.card.jcb
+::: validators.card.mastercard
+::: validators.card.unionpay
+::: validators.card.visa
diff --git a/docs/references/country_code.md b/docs/references/country_code.md
@@ -0,0 +1,3 @@
+# country_code
+
+::: validators.country_code.country_code
diff --git a/docs/references/domain.md b/docs/references/domain.md
@@ -0,0 +1,3 @@
+# domain
+
+::: validators.domain.domain
diff --git a/docs/references/email.md b/docs/references/email.md
@@ -0,0 +1,3 @@
+# email
+
+::: validators.email.email
diff --git a/docs/references/hashes.md b/docs/references/hashes.md
@@ -0,0 +1,7 @@
+# hashes
+
+::: validators.hashes.md5
+::: validators.hashes.sha1
+::: validators.hashes.sha224
+::: validators.hashes.sha256
+::: validators.hashes.sha512
diff --git a/docs/references/hostname.md b/docs/references/hostname.md
@@ -0,0 +1,3 @@
+# hostname
+
+::: validators.hostname.hostname
diff --git a/docs/references/i18n.md b/docs/references/i18n.md
@@ -0,0 +1,10 @@
+# i18n
+
+::: validators.i18n.es_cif
+::: validators.i18n.es_doi
+::: validators.i18n.es_nie
+::: validators.i18n.es_nif
+::: validators.i18n.fi_business_id
+::: validators.i18n.fi_ssn
+::: validators.i18n.fr_department
+::: validators.i18n.fr_ssn
diff --git a/docs/references/iban.md b/docs/references/iban.md
@@ -0,0 +1,3 @@
+# iban
+
+::: validators.iban.iban
diff --git a/docs/references/ip_address.md b/docs/references/ip_address.md
@@ -0,0 +1,4 @@
+# ip_address
+
+::: validators.ip_address.ipv4
+::: validators.ip_address.ipv6
diff --git a/docs/references/length.md b/docs/references/length.md
@@ -0,0 +1,3 @@
+# length
+
+::: validators.length.length
diff --git a/docs/references/mac_address.md b/docs/references/mac_address.md
@@ -0,0 +1,3 @@
+# mac_address
+
+::: validators.mac_address.mac_address
diff --git a/docs/references/slug.md b/docs/references/slug.md
@@ -0,0 +1,3 @@
+# slug
+
+::: validators.slug.slug
diff --git a/docs/references/url.md b/docs/references/url.md
@@ -0,0 +1,3 @@
+# url
+
+::: validators.url.url
diff --git a/docs/references/utils.md b/docs/references/utils.md
@@ -0,0 +1,4 @@
+# utils
+
+::: validators.utils.ValidationError
+::: validators.utils.validator
diff --git a/docs/references/uuid.md b/docs/references/uuid.md
@@ -0,0 +1,3 @@
+# uuid
+
+::: validators.uuid.uuid
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -1,6 +1,6 @@
 site_name: "validators"
 site_description: "Automatic documentation from sources, for MkDocs."
-site_url: "https://python-validators.github.io/validators/"
+site_url: "https://yozachar.github.io/pyvalidators/"
 repo_url: "https://github.com/python-validators/validators"
 edit_uri: "edit/master/docs/"
 repo_name: "validators/validators"
@@ -48,15 +48,37 @@ plugins:
           import:
             - https://docs.python-requests.org/en/master/objects.inv
   - git-revision-date-localized
+  - mike
 
 extra:
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/python-validators
     - icon: fontawesome/brands/python
       link: https://pypi.org/project/validators
+  version:
+    provider: mike
+    default: dev
 
-copyright: Copyright &copy; 2013 - 2023 Konsta Vesterinen
+copyright: Copyright &copy; 2013 - 2024 Konsta Vesterinen
 
 nav:
   - Home: index.md
+  - API:
+      - references/between.md
+      - references/btc_address.md
+      - references/card.md
+      - references/country_code.md
+      - references/domain.md
+      - references/email.md
+      - references/hashes.md
+      - references/hostname.md
+      - references/i18n.md
+      - references/iban.md
+      - references/ip_address.md
+      - references/length.md
+      - references/mac_address.md
+      - references/slug.md
+      - references/url.md
+      - references/utils.md
+      - references/uuid.md
diff --git a/package/roll.sh b/package/roll.sh
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -61,6 +61,7 @@ docs-online = [
     "mkdocs-material>=9.5.6",
     "mkdocstrings[python]>=0.24.0",
     "pyaml>=23.12.0",
+    "mike>=2.0.0",
 ]
 hooks = ["pre-commit>=3.5.0"]
 package = ["build>=1.0.3", "twine>=4.0.2"]

diff --git a/src/export/__main__.py b/src/export/__main__.py
@@ -46,7 +46,7 @@ def _generate_reference(source: Path, destination: Path, ext: str):
         for alias in aliases:
             _write_ref_content(destination / f"{module_name}.{ext}", module_name, alias.name)
         if ext == "md":
-            nav_items["Code Reference"].append(f"reference/{module_name}.md")
+            nav_items["Code Reference"].append(f"references/{module_name}.md")
     return nav_items
 
 
@@ -91,7 +91,7 @@ def _gen_rst_docs(source: Path, refs_path: Path, only_web: bool = False, only_ma
             + "\n   :maxdepth: 2"
             + "\n   :caption: Reference:"
             + "\n   :glob:\n"
-            + "\n   reference/*\n"
+            + "\n   references/*\n"
         )
     # generate RST reference documentation
     _generate_reference(source / "src/validators/__init__.py", refs_path, "rst")
@@ -128,7 +128,7 @@ def generate_documentation(
     # copy readme as docs index file
     copy(source / "README.md", source / "docs/index.md")
     # clean destination
-    refs_path = source / "docs/reference"
+    refs_path = source / "docs/references"
     if refs_path.is_dir():
         rmtree(refs_path)
     refs_path.mkdir(exist_ok=True)
@@ -174,7 +174,7 @@ def package(source: Path):
             only_md=True,
             only_rst_web=False,
             only_rst_man=False,
-            discard_refs=True,
+            discard_refs=False,
         )
     quit(exit_code)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# btc_address

		::: validators.btc_address.btc_address
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# country_code

		::: validators.country_code.country_code
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# mac_address

		::: validators.mac_address.mac_address