From 3b558424bf20768652accebb7401780426d212ee Mon Sep 17 00:00:00 2001 From: Nima Ghorbani Date: Wed, 3 Jun 2026 13:55:52 +0200 Subject: [PATCH] ci(docs): remove nightly dev deploy so the site has no /dev channel deploy-docs.yml published a `dev` mike version on every push to main, which surfaced as /dev/ on the docs site. Docs now publish only on v*.*.* release tags via deploy-docs-versioned.yml. The dev version was also removed from gh-pages. --- .github/workflows/deploy-docs.yml | 53 ------------------------------- CHANGELOG.md | 1 + 2 files changed, 1 insertion(+), 53 deletions(-) delete mode 100644 .github/workflows/deploy-docs.yml diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml deleted file mode 100644 index f7201d0..0000000 --- a/.github/workflows/deploy-docs.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Deploy docs to GitHub Pages (nightly) - -on: - push: - branches: [main] - -permissions: - contents: write - -concurrency: - group: docs-deploy - cancel-in-progress: false - -jobs: - deploy: - runs-on: ubuntu-latest - container: - image: cubertgmbh/cuvis_pyil:3.5.3-ubuntu24.04 - steps: - - name: Install build dependencies - run: apt-get update -y && apt-get install -y git doxygen graphviz - - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - submodules: recursive - - - name: Mark workspace as safe for Git - run: git config --global --add safe.directory "$GITHUB_WORKSPACE" - - - name: Stage cuvis.h for Doxygen - run: | - mkdir -p docs/_api_sources - cp /usr/include/cuvis.h docs/_api_sources/cuvis.h - - - name: Install uv - uses: astral-sh/setup-uv@v4 - with: - enable-cache: true - - - name: Sync docs deps - run: uv venv --system-site-packages && uv sync --extra docs - - - name: Configure git for mike - run: | - git config user.name "github-actions[bot]" - git config user.email "github-actions[bot]@users.noreply.github.com" - - - name: Build docs (strict) - run: uv run mkdocs build --strict - - - name: Deploy dev (nightly) docs - run: uv run mike deploy --push dev diff --git a/CHANGELOG.md b/CHANGELOG.md index f5c09da..ff29dba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Unreleased +- **CI/docs:** removed the nightly `deploy-docs.yml`, which published a `dev` mike version on every push to `main`. The docs site now updates only on `v*.*.*` release tags (`deploy-docs-versioned.yml`) — no `/dev/` channel. (The existing `dev` version was also deleted from `gh-pages`.) - **CI: fixed the docs deploy failing in-container.** Added `git config --global --add safe.directory "$GITHUB_WORKSPACE"` after checkout in both deploy workflows; without it git rejected the container-checked-out workspace (`fatal: not in a git directory`), so the `mike` deploy could never push to `gh-pages`. - **Documentation site migrated into this repo** (from `cuvis.doc`) and published to GitHub Pages. Versioned with `mike`: pushing a `v*.*.*` tag publishes that version aliased to `latest` (`deploy-docs-versioned.yml`), and pushes to `main` publish a `dev` build (`deploy-docs.yml`). C and C++ API reference generated from the headers via `mkdoxy` (Doxygen XML), Python API reference via `mkdocstrings`, example pages generated from the Python notebooks, and an `llms.txt` / `llms-full.txt` index via `mkdocs-llmstxt`. - Rebranded the mkdocs site to follow Cubert CI. Switched the Material `palette` to `primary/accent: custom` and let `docs/stylesheets/extra.css` drive the palette directly across both Material schemes. Headings use Rajdhani via a Google Fonts `@import`; body and code stay on Roboto / Roboto Mono via Material's font loader. Existing `.sdk-installer` widget styles are preserved on top of the brand palette.