Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# SPDX-FileCopyrightText: 2026 CERN <home.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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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/).

=======

Expand Down Expand Up @@ -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).