Build sphinx docs

.dockerignore

@@ -9,4 +9,3 @@
 /build
 /dist
 /Dockerfile
-/docs

.github/workflows/tests.yml

@@ -54,6 +54,21 @@ jobs:
       - name: Lint and Type Checking
         run: docker run --rm --entrypoint="" amp pipenv run lint
 
+  doc:
+    name: Documentation Building Test
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get Docker Image
+        uses: actions/download-artifact@v2
+        with:
+          name: image
+      - name: Load Docker Image
+        run: docker load < docker-image.tar
+      - name: Build Documentation
+        run: docker run --rm --entrypoint="" --user=0:0 amp pipenv run doc -nW --keep-going
+
   push:
     name: Upload the Docker image to Docker Hub
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -28,7 +28,7 @@ fixing your issue as quickly as possible.
 
 The tools required to work on the Azafea metrics proxy are the following:
 
-*   Python >= 3.7, with Pip
+*   Python >= 3.8, with Pip
 *   [pipenv](https://docs.pipenv.org/)
 
 Pipenv is not strictly mandatory to contribute to the Azafea metrics proxy, you

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7-alpine
+FROM python:3.8-alpine
 
 RUN pip install --no-cache-dir pipenv template && \
     apk add --update --no-cache git build-base

Pipfile

@@ -1,20 +1,25 @@
+[requires]
+python_version = "3.8"
+
 [dev-packages]
 flake8-bugbear = "*"
 freezegun = "*"
 mypy = ">=0.720"
-pytest = "*"
-pytest-aiohttp = "*"
+pytest = "~= 6.2"
+pytest-aiohttp = "~= 0.3"
 pytest-cov = "*"
 pytest-flake8 = "*"
 pytest-mypy = ">=0.3.3"
+sphinx = "*"
 
 [packages]
 aiohttp = ">= 3.5.0"
 aioredis = "~= 1.3"
-pydantic = ">= 1.1"
+pydantic = "~= 1.1"
 toml = "*"
 
 [scripts]
+doc = "sphinx-build -b html docs/source docs/build/html"
 lint = "py.test --flake8 --mypy -m 'flake8 or mypy'"
 proxy = "python -m azafea_metrics_proxy"
 test = "py.test --cov=azafea_metrics_proxy --cov-fail-under=99 --no-cov-on-fail -m 'not integration'"

setup.cfg

@@ -19,7 +19,7 @@ license_file = COPYING
 
 [options]
 packages = find:
-python_requires = >= 3.7
+python_requires = >= 3.8
 
 [options.package_data]
 azafea_metrics_proxy = py.typed