Add test step for building the documentation (#228)

* Add test step for building the documentation

* Add dummy commit to break tests

* Revert docs to working state

* Make docs a separate GHA

Co-authored-by: Oliver Crawford <oliver.crawford@skyscanner.net>

.github/workflows/test-docs.yml

@@ -0,0 +1,21 @@
+name: Test Docs
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    name: Test Docs
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - run: make install-docs
+
+      - run: make test-docs

.gitignore

@@ -1,3 +1,4 @@
+# IDEs
 .idea/
 .vscode/
 
@@ -7,6 +8,7 @@
 # Virtualenv
 venv
 
+# Other
 .DS_Store
 .project
 .pydevproject
@@ -44,10 +46,6 @@ MANIFEST
 *.manifest
 *.spec
 
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -74,3 +72,6 @@ venv.bak/
 
 # Snyk Code
 .dccache
+
+# MkDocs local builds
+site/

Makefile

@@ -37,6 +37,9 @@ coverage:
 
 test: lint unit
 
+test-docs:
+	mkdocs build --strict
+
 freeze:
 	CUSTOM_COMPILE_COMMAND="make freeze" pip-compile --no-emit-index-url --no-annotate --output-file requirements.txt setup.py