From c3e43aba87e3155abff4f89e9a1375271ceafbe5 Mon Sep 17 00:00:00 2001 From: Ci7rix <12910735+Ci7rix@users.noreply.github.com> Date: Fri, 19 Jun 2026 17:13:01 +0200 Subject: [PATCH 1/3] Adding requirements for documentation and add copy button --- Taskfile.yml | 5 +++++ docs/requirements.txt | 3 +++ mkdocs.yml | 2 ++ 3 files changed, 10 insertions(+) create mode 100644 docs/requirements.txt 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 From da29944e96b139641ab423fc17438f3091f1c6fe Mon Sep 17 00:00:00 2001 From: Ci7rix <12910735+Ci7rix@users.noreply.github.com> Date: Fri, 19 Jun 2026 17:15:33 +0200 Subject: [PATCH 2/3] Using requirements.txt in actions --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a3e39fb..92101a8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,7 +18,7 @@ jobs: with: python-version: "3.x" - - run: pip install mkdocs-material mdx-truly-sane-lists mike + - run: pip install -r docs/requirements.txt - name: Configure git run: | From 4cd9389c958f8532f41a6cd5ec8d8b4d4e65d784 Mon Sep 17 00:00:00 2001 From: Ci7rix <12910735+Ci7rix@users.noreply.github.com> Date: Fri, 19 Jun 2026 17:44:17 +0200 Subject: [PATCH 3/3] Validating doc in action --- .github/workflows/docs.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 92101a8..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 @@ -20,10 +25,15 @@ jobs: - 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