Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix building docs #589

Merged
merged 1 commit into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/docs-build-try.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/pages/message_decorator.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 0 additions & 4 deletions docs/pages/subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs==1.6.0
mkdocs==1.5.3
mike==2.0.0
markdown==3.6
mkdocs-material==9.5.18
Expand Down
Loading