-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
545aa0a
commit f47c37d
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: Test mkdocs | ||
on: | ||
push: | ||
branches: | ||
- 'docs/**' | ||
pull_request: | ||
branches: | ||
- 'main' | ||
paths: | ||
- 'docs/**' | ||
- 'mkdocs.yml' | ||
- '.github/workflows/test-mkdocs.yml' | ||
|
||
jobs: | ||
mkdocs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- | ||
name: Checkout PR | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- | ||
name: Install mkdocs and dependencies | ||
run: | | ||
pip install --upgrade pip | ||
pip install mkdocs | ||
pip install -r docs/requirements.txt | ||
- | ||
name: Check docs build ok in native mkdocs | ||
run: | | ||
mkdocs -V | ||
mkdocs build -s | ||
- | ||
name: Check docs build ok with amazee.io mkdocs image | ||
run: | | ||
docker run --rm ghcr.io/amazeeio/mkdocs-material -V | ||
docker run --rm -p 8000:8000 -v ${PWD}:/docs ghcr.io/amazeeio/mkdocs-material build -s |