diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a3e39fb..a83d90a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,6 +2,11 @@ name: docs on: push: branches: [main] + pull_request: + paths: + - "docs/**" + - "mkdocs.yml" + - ".github/workflows/docs.yml" permissions: contents: write @@ -18,12 +23,17 @@ jobs: with: python-version: "3.x" - - run: pip install mkdocs-material mdx-truly-sane-lists mike + - run: pip install -r docs/requirements.txt + + - name: Build docs (validation) + run: mkdocs build --strict - name: Configure git + if: github.ref == 'refs/heads/main' run: | git config user.name 'github-actions[bot]' git config user.email 'github-actions[bot]@users.noreply.github.com' - name: Deploy main docs + if: github.ref == 'refs/heads/main' run: mike deploy --push --update-aliases main diff --git a/Taskfile.yml b/Taskfile.yml index 6f511c7..207e36a 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -42,6 +42,11 @@ tasks: cmds: - git-cliff -o CHANGELOG.md + docs:install: + desc: Install documentation dependencies + cmds: + - pip install -r docs/requirements.txt + docs: desc: Serve documentation locally cmds: diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..0f9b500 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +mkdocs-material +mdx-truly-sane-lists +mike diff --git a/mkdocs.yml b/mkdocs.yml index 93a69cf..5260842 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,8 @@ theme: name: material logo: assets/topf.png favicon: assets/topf.png + features: + - content.code.copy palette: - media: "(prefers-color-scheme: light)" scheme: default