Merge pull request #589 from patchlevel/fix-docs

fix building docs

.github/workflows/docs-build-try.yml

@@ -0,0 +1,29 @@
+name: Try build docs
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "renovate/*"
+
+jobs:
+  build-try:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build docs
+        working-directory: docs/
+        run: |
+          mkdocs build --strict

docs/mkdocs.yml

@@ -96,3 +96,9 @@ nav:
     - Time / Clock: clock.md
     - Testing: testing.md
     - CLI: cli.md
+
+validation:
+  omitted_files: warn
+  absolute_links: warn  # Or 'relative_to_docs' - new in MkDocs 1.6
+  unrecognized_links: warn
+  #anchors: warn

docs/pages/message_decorator.md

@@ -68,7 +68,7 @@ $repository = $repositoryManager->get(Profile::class);
 ```
 !!! note
 
-    You can find out more about repository [here](repository).
+    You can find out more about repository [here](repository.md).
 
 ## Create own decorator
 

docs/pages/store.md

@@ -68,7 +68,7 @@ With the help of the `SchemaDirector`, the database structure can be created, up
 
 !!! tip
 
-    You can also use doctrine [migration](migration.md) to create and keep your schema in sync.
+    You can also use doctrine migration to create and keep your schema in sync.
 
 ### Schema Director
 

docs/pages/subscription.md

@@ -78,10 +78,6 @@ final class ProfileProjector
     MySQL and MariaDB don't support transactions for DDL statements.
     So you must use a different database connection for your subscriptions.
 
-!!! note
-
-    More about the projector and projections can be found [here](projection.md).
-
 !!! tip
 
     Add a version as suffix to the subscriber id

docs/pages/testing.md

@@ -90,7 +90,7 @@ final class ProfileTest extends TestCase
 ```
 !!! note
 
-    You can find out more about the clock [here](clock).
+    You can find out more about the clock [here](clock.md).
 
 !!! tip
 

docs/requirements.txt

@@ -1,4 +1,4 @@
-mkdocs==1.6.0
+mkdocs==1.5.3
 mike==2.0.0
 markdown==3.6
 mkdocs-material==9.5.18