Add qoqo_examples documentation

.github/workflows/hqs-build-deploy-sphinx-doc-rust-pyo3.yml

@@ -6,10 +6,34 @@ on:
     types: [created]
 
 jobs:
-
   publish_documentation:
-    uses: HQSquantumsimulations/reusable_workflows/.github/workflows/reusable_publish_documentation_rust_sphinx.yml@main
-    with: 
-      py_interface_folder: "qoqo"
-      py_docs_folder: "qoqo/docs"
-    secrets: inherit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - uses: peaceiris/actions-mdbook@v1
+        with:
+          version: latest
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          default: true
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip maturin
+          pip install ${{inputs.py_interface_folder}}/[docs]
+      - name: build
+        run: |
+          cd ${{inputs.py_docs_folder}}
+          python -m sphinx -T -E -b html . _build/html
+          mv _build/html ../../documentation/src/python_api_docs
+          cd ../..
+          mdbook build documentation
+      - name: publish
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: documentation/book

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This changelog track changes to the qoqo project starting at version v0.5.0
 
+## Unreleased
+
+* Added the documentation from qoqo_examples.
+
 ## 1.16.1
 
 ### Fixed in 1.16.1

documentation/book.toml

@@ -0,0 +1,10 @@
+[book]
+authors = ["HQS Quantum Simulations <[email protected]>"]
+language = "en"
+multilingual = false
+src = "src"
+title = "HQS qoqo User Documentation"
+
+
+[output.html]
+mathjax-support = true

documentation/src/SUMMARY.md

@@ -0,0 +1,23 @@
+# qoqo/roqoqo User Guide
+
+[Introduction](introduction.md)
+
+- [Installation](installation.md)
+- [Quantum Circuits](circuits/intro.md)
+  - [Unitary Operations](circuits/unitary.md)
+  - [Readout](circuits/readout.md)
+  - [Pragma Operations](circuits/pragma.md)
+  - [Noise Operations](circuits/noise.md)
+- [High-Level Interface: Quantum Programs](high-level/intro.md)
+  - [PauliZProduct Measurement](high-level/pauliz.md)
+  - [QuantumProgram and Variable-Replacement](high-level/program.md)
+  - [ClassicalRegister Measurement](high-level/classical.md)
+  - [CheatedPauliZProduct Measurement](high-level/pauliz_cheated.md)
+  - [Cheated Measurement](high-level/cheated.md)
+- [Backends](backends.md)
+- [Devices](devices.md)
+- [Conventions](conventions.md)
+- [List of Gate Operations](gate_operations/intro.md)
+  - [Single-Qubit Gates](gate_operations/single_qubit_gates.md)
+  - [Two-Qubit Gates](gate_operations/two_qubit_gates.md)
+  - [Multi-Qubit Gates](gate_operations/multi_qubit_gates.md)