Fix docs CI workflow

link generation was breaking becuase of a link to docker-compose which
has now been removed. Also update the CI github action to use poetry to
install deps and potentially resolve build error

Author: mikeywaites

.github/workflows/lint-docs.yml

@@ -1,27 +1,29 @@
 name: Verify documentation
 on:
   push:
-    branches: [ "main", "master" ]
+    branches: ["main", "master"]
   pull_request:
-    branches: [ "main", "master" ]
+    branches: ["main", "master"]
 
 jobs:
   verify-docs:
     name: Check Documentation
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install .[tests]
-    - name: Build docs with MkDocs
-      run: |
-        make docs
-    - name: Check Markdown links
-      uses: gaurav-nelson/github-action-markdown-link-check@v1
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install Poetry
+        run: curl -sSL https://install.python-poetry.org | python
+      - name: Install dependencies
+        run: |
+          poetry env use '3.10'
+          poetry install --extras=testing
+      - name: Build docs with MkDocs
+        run: |
+          make docs
+      - name: Check Markdown links
+        uses: gaurav-nelson/github-action-markdown-link-check@v1

Makefile

@@ -44,4 +44,4 @@ clean:
 	find . -name '.bak' -exec rm -f {} +
 
 docs:
-	mkdocs build --site-dir=html
+	poetry run mkdocs build --site-dir=html

docs/testcontainers.md

@@ -105,7 +105,7 @@ WireMockContainer(verify_ssl_certs=False)
 
 ## Using WireMockContainer inside Docker (dind)
 
-It's common that you might need to start Testcontainers from inside of another container. The example project in [Testcontainer Example](../example/docker-compose.yml) actually does this.
+It's common that you might need to start Testcontainers from inside of another container. The example project in `example/docker-compose.yml` actually does this.
 
 When running spawning testcontainer inside of another container you will need to set the `WIREMOCK_DIND` config variable to true. When this env var is set the host of the wiremock container
 will explicitly be set to `host.docker.internal`.