From 989a0fab99d321a44b918fd6e37c1d9b77afa234 Mon Sep 17 00:00:00 2001 From: alvaro Date: Thu, 27 Aug 2026 16:21:53 +0200 Subject: [PATCH 1/3] small changes on CHANGELOG and README.md --- CHANGELOG.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4ff0ac..2fa3205 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [0.6.1] - 2028-08-27 +## [0.6.1] - 2026-08-27 - Add CHANGELOG.md - No changes in software code diff --git a/README.md b/README.md index a0eba05..5dfd17a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 # pypts -![pypts quick run](images/pypts_quick_run.gif) +![pypts GIF](images/pypts_quick_run.gif) Hardware-oriented testing framework developed by BE-CEM-MTA. From d31120f722a4f97a2ba1571570b5d5a76592203b Mon Sep 17 00:00:00 2001 From: alvaro Date: Thu, 27 Aug 2026 16:41:07 +0200 Subject: [PATCH 2/3] add build-docs job to release.yml --- .github/workflows/release.yml | 46 +++++++++++++++++++++++++++++++++++ README.md | 4 +-- 2 files changed, 48 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d4a6ee6..16e1330 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -92,3 +92,49 @@ jobs: - name: Publish distributions uses: pypa/gh-action-pypi-publish@release/v1 + + build-docs: + name: Build Sphinx documentation + needs: build + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - name: Check out source + uses: actions/checkout@v6 + with: + fetch-depth: 0 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Install the package with documentation dependencies + run: python -m pip install ".[doc]" + + - name: Build documentation + run: python -m sphinx -W --keep-going -b html docs/source docs/build/html + + - name: Disable Jekyll processing + run: touch docs/build/html/.nojekyll + + - name: Upload documentation artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/build/html + + deploy-docs: + name: Deploy documentation to GitHub Pages + needs: build-docs + runs-on: ubuntu-latest + timeout-minutes: 10 + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + pages: write + id-token: write + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 5dfd17a..620ee3d 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Hardware-oriented testing framework developed by BE-CEM-MTA. * **HTML Reports:** Provides a utility to convert the CSV report into a styled HTML file (`report.html`) for easy viewing, similar to `pytest-html`. * **Event System:** Uses queues for inter-thread communication and event reporting (e.g., step start/end). -For full documentation, please visit [PTS Framework Documentation](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/). +For full documentation, please visit [PTS Framework Documentation](https://cern.github.io/pts-framework/). ======= @@ -52,4 +52,4 @@ artifact for 30 days; PyPI is the permanent package source. See pypts is distributed under the **LGPL-2.1-or-later** licence. -pypts comes with a [dependency licence compatibility analysis report](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/dependency_license_analysis.html). +pypts comes with a [dependency licence compatibility analysis report](https://cern.github.io/pts-framework/dependency_license_analysis.html). From cfd4fa443cb99806e3aeb9d5221277336e5d91ff Mon Sep 17 00:00:00 2001 From: alvaro Date: Thu, 27 Aug 2026 16:43:11 +0200 Subject: [PATCH 3/3] split build-docs job --- .github/workflows/docs.yml | 63 +++++++++++++++++++++++++++++++++++ .github/workflows/release.yml | 46 ------------------------- 2 files changed, 63 insertions(+), 46 deletions(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..f82005c --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,63 @@ +# SPDX-FileCopyrightText: 2026 CERN +# +# SPDX-License-Identifier: LGPL-2.1-or-later + +name: Documentation + +on: + push: + tags: ["v*"] + workflow_dispatch: {} + +permissions: + contents: read + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + build-docs: + name: Build Sphinx documentation + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - name: Check out source + uses: actions/checkout@v6 + with: + fetch-depth: 0 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Install the package with documentation dependencies + run: python -m pip install ".[doc]" + + - name: Build documentation + run: python -m sphinx -W --keep-going -b html docs/source docs/build/html + + - name: Disable Jekyll processing + run: touch docs/build/html/.nojekyll + + - name: Upload documentation artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/build/html + + deploy-docs: + name: Deploy documentation to GitHub Pages + needs: build-docs + runs-on: ubuntu-latest + timeout-minutes: 10 + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + pages: write + id-token: write + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 16e1330..d4a6ee6 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -92,49 +92,3 @@ jobs: - name: Publish distributions uses: pypa/gh-action-pypi-publish@release/v1 - - build-docs: - name: Build Sphinx documentation - needs: build - runs-on: ubuntu-latest - timeout-minutes: 15 - steps: - - name: Check out source - uses: actions/checkout@v6 - with: - fetch-depth: 0 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: "3.13" - - - name: Install the package with documentation dependencies - run: python -m pip install ".[doc]" - - - name: Build documentation - run: python -m sphinx -W --keep-going -b html docs/source docs/build/html - - - name: Disable Jekyll processing - run: touch docs/build/html/.nojekyll - - - name: Upload documentation artifact - uses: actions/upload-pages-artifact@v3 - with: - path: docs/build/html - - deploy-docs: - name: Deploy documentation to GitHub Pages - needs: build-docs - runs-on: ubuntu-latest - timeout-minutes: 10 - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - permissions: - pages: write - id-token: write - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4