From 14f3235e53a30cdb6cf0c593d7fb6d8e2e55692f Mon Sep 17 00:00:00 2001 From: Lucas Bickel <116588+hairmare@users.noreply.github.com> Date: Mon, 25 Mar 2024 23:12:06 +0100 Subject: [PATCH] chore(ci): enable mkdocs in ci (#429) --- .github/workflows/release.yaml | 5 ++++- .gitignore | 1 + docs/gen_ref_pages.py | 5 +++++ mkdocs.yaml | 2 ++ 4 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index e239c169..c8d6a572 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,10 +1,11 @@ name: Release on: + pull_request: push: + branches: [main] tags: - 'v*.*.*' - pull_request: jobs: release-container: @@ -14,6 +15,8 @@ jobs: name: 'catpage' display-name: 'Cat Page' tags: 'minimal rhel9 rabe s2i python python311 catpage' + release-mkdocs: + uses: radiorabe/actions/.github/workflows/release-mkdocs.yaml@v0.20.6 helm-chart: runs-on: ubuntu-latest if: startsWith(github.ref, 'refs/tags/v') diff --git a/.gitignore b/.gitignore index 02865a7e..22ef8db3 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ __pycache__ /.coverage /node_modules/ venv/ +.venv/ diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py index e35a6f38..0f8921bd 100644 --- a/docs/gen_ref_pages.py +++ b/docs/gen_ref_pages.py @@ -33,3 +33,8 @@ "w", ) as index_file: index_file.writelines(readme.read()) + +with Path("docs/screenshot.png").open("rb") as orig, mkdocs_gen_files.open( + "docs/screenshot.png", "wb" +) as screenshot: + screenshot.write(orig.read()) diff --git a/mkdocs.yaml b/mkdocs.yaml index 6d8b3d1f..eebf8a6d 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -7,11 +7,13 @@ theme: palette: # Palette toggle for dark mode - scheme: slate + primary: '#00c9bf' toggle: icon: material/brightness-4 name: Switch to light mode # Palette toggle for light mode - scheme: default + primary: '#00c9bf' toggle: icon: material/brightness-7 name: Switch to dark mode