From e6eaaee99948f37fa290926b824d533f18e7f960 Mon Sep 17 00:00:00 2001 From: JMuff22 Date: Tue, 17 Dec 2024 15:31:53 +0200 Subject: [PATCH 1/3] Add test-docs github action to test that the documentation can be built in pull request --- .github/workflows/test-docs.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/test-docs.yml diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml new file mode 100644 index 0000000..cd69d98 --- /dev/null +++ b/.github/workflows/test-docs.yml @@ -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 --site-dir test From 139096dbf720c6b662bae42a4772a7fc1c88e199 Mon Sep 17 00:00:00 2001 From: JMuff22 Date: Tue, 17 Dec 2024 15:35:09 +0200 Subject: [PATCH 2/3] add strict flag --- .github/workflows/test-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml index cd69d98..7c9b7ba 100644 --- a/.github/workflows/test-docs.yml +++ b/.github/workflows/test-docs.yml @@ -23,4 +23,4 @@ jobs: - name: Test documentation build run: | - mkdocs build --site-dir test + mkdocs build --strict --site-dir test From d33fb579cc233c52fdcfb8680afb8a505e006f4f Mon Sep 17 00:00:00 2001 From: JMuff22 Date: Tue, 17 Dec 2024 15:38:34 +0200 Subject: [PATCH 3/3] Fix building --- docs/examples/index.md | 2 +- mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/examples/index.md b/docs/examples/index.md index 349ac37..0cfcbe7 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -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) diff --git a/mkdocs.yml b/mkdocs.yml index 90f9405..ac4af2c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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