Run mkdocs build end-to-end as a final test step

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

.github/workflows/test.yml

@@ -23,3 +23,8 @@ jobs:
       - name: Test with unittest
         run: |
           python -m unittest src/test_core.py
+      - name: Run mkdocs build end-to-end
+        run: |
+          pip list --format=freeze | xargs pip uninstall -y
+          pip install --editable .
+          mkdocs build --config-file test-fixtures/mkdocs.yml

.gitignore

@@ -119,6 +119,7 @@ venv.bak/
 
 # mkdocs documentation
 /site
+/test-fixtures/site
 
 # mypy
 .mypy_cache/

test-fixtures/docs/index.md

@@ -0,0 +1,3 @@
+# Home
+
+This is a piece of documentation.

test-fixtures/mkdocs.yml

@@ -0,0 +1,10 @@
+site_name: Fixture Docs
+site_description: Used as a simple end-to-end test of the techdocs-core plugin.
+repo_url: https://github.com/backstage/mkdocs-techdocs-core
+edit_uri: edit/main/test-fixtures/docs
+
+plugins:
+  - techdocs-core
+
+nav:
+  - Home: index.md