diff --git a/.github/workflows/docs-build-try.yml b/.github/workflows/docs-build-try.yml new file mode 100644 index 00000000..c4d8f316 --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a5d6c06d..dc8e0413 100644 --- a/docs/mkdocs.yml +++ b/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 \ No newline at end of file diff --git a/docs/pages/message_decorator.md b/docs/pages/message_decorator.md index a025f333..cff647a5 100644 --- a/docs/pages/message_decorator.md +++ b/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 diff --git a/docs/pages/store.md b/docs/pages/store.md index 31e38ae5..62bea08d 100644 --- a/docs/pages/store.md +++ b/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 diff --git a/docs/pages/subscription.md b/docs/pages/subscription.md index adfe32de..f5d6a28f 100644 --- a/docs/pages/subscription.md +++ b/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 diff --git a/docs/pages/testing.md b/docs/pages/testing.md index b6388478..e1935b8c 100644 --- a/docs/pages/testing.md +++ b/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 diff --git a/docs/requirements.txt b/docs/requirements.txt index 20812e83..726e5104 100644 --- a/docs/requirements.txt +++ b/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