Rework tasks and docs generation

.envrc

@@ -0,0 +1 @@
+PATH_add devbin

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: Docs
+
+on: [pull_request]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install enchant and dictionary
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get -y install enchant-2 hunspell-en-us
+
+      - name: Install dependencies
+        run: pip install .[dev]
+
+      - name: Build docs
+        run: devbin/build-docs

.github/workflows/test.yml

@@ -31,11 +31,6 @@ jobs:
           restore-keys: |
             ${{ matrix.os }}-${{ matrix.python-version }}-v1-
 
-      - name: Install enchant
-        run: |
-          sudo apt-get -qq update
-          sudo apt-get -y install enchant-2
-
       - name: Install dependencies
         run: |
           python -m pip install -U pip

HISTORY.rst

@@ -31,7 +31,7 @@ History
 2.5.0 (2021-07-26)
 ++++++++++++++++++
 
-* Improvied error messages for field validation errors.
+* Improvised error messages for field validation errors.
 * Allowed to validate non model list items.
 * Added DictField.
 

README.rst

@@ -398,7 +398,7 @@ that can be expressed in json schema if you want to be 100% correct on schema si
 
 * Dealing with schemaless data
 
-(Plese note that using schemaless fields can cause your models to get out of control - especially if
+(Please note that using schemaless fields can cause your models to get out of control - especially if
 you are the one responsible for data schema. On the other hand there is usually the case when incomming
 data are with no schema defined and schemaless fields are the way to go.)
 

devbin/build-docs

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+sphinx-build -b spelling -d docs/_build/doctress docs docs/build/spelling

docs/spelling_wordlist.txt

@@ -5,8 +5,10 @@ explicite
 django
 docstring
 docstrings
+Garimort
 indices
 jsonmodels
+jsonschema
 kwargs
 metaclass
 namedtuple
@@ -16,3 +18,4 @@ szczepan
 regex
 validator
 validators
+virtualenv

docs/usage.rst

@@ -249,7 +249,7 @@ is possible to you to operate just on models.
     >>> person = Person()
     >>> schema = person.to_json_schema()
 
-And thats it! You can serve then this schema through your API or use it for
+And that's it! You can serve then this schema through your API or use it for
 validation incoming data.
 
 Different names in structure and objects

jsonmodels/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("jsonmodels")
+except PackageNotFoundError:
+    __version__ = "unknown"

pyproject.toml

@@ -32,13 +32,8 @@ dev = [
   "Sphinx",
   "coverage",
   "docutils",
-  "flake8",
-  "flake8-pyproject",
   "invoke",
   "isort",
-  "mccabe",
-  "pep8",
-  "pyflakes",
   "pytest",
   "pytest-cov",
   "sphinxcontrib-spelling",
@@ -47,10 +42,5 @@ dev = [
 [project.urls]
 "Home" = "https://github.com/jazzband/jsonmodels"
 
-[tool.flake8]
-exclude = ["./docs/conf.py"]
-max-complexity = 8
-max_line_length = 88
-
 [tool.isort]
 profile = "black"

tests/__init__.py

@@ -1,11 +0,0 @@
-def _have_flake8():
-    try:
-        import flake8  # noqa: F401
-
-        return True
-    except ImportError:
-        return False
-
-
-LINT = _have_flake8()
-CHECK_SPELLING = False