feat: auto docs using mkdocstrings

.github/workflows/main.yml

@@ -48,7 +48,7 @@ jobs:
  #----------------------------------------------
  - name: Install dependencies
  # if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
- run: poetry install --no-interaction --no-root
+ run: poetry install --no-interaction --no-root --no-ansi --only tests
  #----------------------------------------------
  # run test suite
  #----------------------------------------------

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+ - repo: https:/pre-commit/pre-commit-hooks
+ rev: v4.4.0
+ hooks:
+ - id: check-added-large-files
+ - id: check-ast
+ - id: check-case-conflict
+ - id: check-toml
+ - id: check-yaml
+ - id: end-of-file-fixer
+ - id: debug-statements
+ - id: destroyed-symlinks
+ - id: trailing-whitespace
+ # will be uncommented when all the
+ # scripts have been revised once
+ # - repo: https:/psf/black
+ # rev: 23.1.0
+ # hooks:
+ # - id: black
+ # - repo: https:/PyCQA/isort
+ # rev: 5.12.0
+ # hooks:
+ # - id: isort
+ # - repo: https:/PyCQA/flake8
+ # rev: 6.0.0
+ # hooks:
+ # - id: flake8

docs/index.md

@@ -0,0 +1,15 @@
+# Reference
+
+::: validators.utils
+
+::: validators.between
+
+::: validators.btc_address
+
+::: validators.card
+
+::: validators.domain
+
+::: validators.email
+
+::: validators.length

mkdocs.yml

@@ -0,0 +1,27 @@
+site_name: "validators"
+site_description: "Automatic documentation from sources, for MkDocs."
+site_url: "https://python-validators.github.io/"
+repo_url: "https:/python-validators/validators"
+edit_uri: "tree/master/docs/"
+repo_name: "validators/validators"
+site_dir: "site"
+watch: [README.md, validators/]
+
+nav:
+ - Reference: index.md
+
+theme:
+ name: material
+
+plugins:
+ - search
+ - mkdocstrings:
+ handlers:
+ python:
+ import:
+ - https://docs.python-requests.org/en/master/objects.inv
+
+extra:
+ social:
+ - icon: fontawesome/brands/github
+ link: https:/python-validators/validators