diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml new file mode 100644 index 0000000..7c9b7ba --- /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 --strict --site-dir test 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