Skip to content
This repository was archived by the owner on Jun 18, 2025. It is now read-only.

Add test-docs github action #14

Merged
JMuff22 merged 3 commits into from
Dec 17, 2024
Merged

Add test-docs github action #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6eaaee
Add test-docs github action to test that the documentation can be bui…
JMuff22 Dec 17, 2024
139096d
add strict flag
JMuff22 Dec 17, 2024
d33fb57
Fix building
JMuff22 Dec 17, 2024
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
26 changes: 26 additions & 0 deletions .github/workflows/test-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Documentation Build Check
on:
pull_request:

permissions:
contents: write

jobs:
check-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions/setup-python@v4
with:
python-version: 3.x

- name: Install dependencies
run: |
pip install -r requirements.txt

- name: Test documentation build
run: |
mkdocs build --strict --site-dir test
2 changes: 1 addition & 1 deletion docs/examples/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ Here you will find a list of examples of using VTT's Quantum computers. Addition
## General
* [Introduction to Helmi with Qiskit](intro-to-helmi-qiskit.ipynb)
* [Introduction to Helmi with Cirq](intro-to-helmi-cirq.ipynb)
* [Visualizing Quality Metrics](visualize_quality_metrics.ipynb)
* [Visualizing Quality Metrics](visualize-quality-metrics.ipynb)
* [Advanced Helmi Usage with Qiskit](advanced-helmi.ipynb)
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nav:
- examples/index.md
- Introduction to Helmi with Qiskit: examples/intro-to-helmi-qiskit.ipynb
- Introduction to Helmi with Cirq: examples/intro-to-helmi-cirq.ipynb
- Visualizing Quality Metrics: examples/visualize_quality_metrics.ipynb
- Visualizing Quality Metrics: examples/visualize-quality-metrics.ipynb
- Advanced Helmi usage with Qiskit: examples/advanced-helmi.ipynb
- Running on Helmi: running.md
- Limitations: limitations.md
Expand Down
Loading