Add qoqo_examples documentation

HQSquantumsimulations · Nov 25, 2024 · 65b5adf · 65b5adf
1 parent 3418134
commit 65b5adf
Show file tree

Hide file tree

Showing 53 changed files with 6,732 additions and 2,588 deletions.
diff --git a/.compatibility_tests/compatibility_test_1_0/Cargo.toml b/.compatibility_tests/compatibility_test_1_0/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_0"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_10/Cargo.toml b/.compatibility_tests/compatibility_test_1_10/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 authors = ["HQS Quantum Simulations <[email protected]>"]
 name = "compatibility_test_1_10"
-version = "1.16.1"
+version = "1.16.2"
 license = "Apache-2.0"
 edition = "2021"
 rust-version = "1.70"

diff --git a/.compatibility_tests/compatibility_test_1_11/Cargo.toml b/.compatibility_tests/compatibility_test_1_11/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_11"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_12/Cargo.toml b/.compatibility_tests/compatibility_test_1_12/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_12"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_13/Cargo.toml b/.compatibility_tests/compatibility_test_1_13/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_13"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_14/Cargo.toml b/.compatibility_tests/compatibility_test_1_14/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_14"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_15/Cargo.toml b/.compatibility_tests/compatibility_test_1_15/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_15"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_2/Cargo.toml b/.compatibility_tests/compatibility_test_1_2/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_2"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_3/Cargo.toml b/.compatibility_tests/compatibility_test_1_3/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_3"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_4/Cargo.toml b/.compatibility_tests/compatibility_test_1_4/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_4"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_5/Cargo.toml b/.compatibility_tests/compatibility_test_1_5/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_5"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_6/Cargo.toml b/.compatibility_tests/compatibility_test_1_6/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_6"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_7/Cargo.toml b/.compatibility_tests/compatibility_test_1_7/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_7"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_8/Cargo.toml b/.compatibility_tests/compatibility_test_1_8/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_8"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_1_9/Cargo.toml b/.compatibility_tests/compatibility_test_1_9/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_1_9"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.compatibility_tests/compatibility_test_sim/Cargo.toml b/.compatibility_tests/compatibility_test_sim/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "compatibility_test_sim"
-version = "1.16.1"
+version = "1.16.2"
 authors = ["HQS Quantum Simulations <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/.github/workflows/hqs-build-deploy-sphinx-doc-rust-pyo3.yml b/.github/workflows/hqs-build-deploy-sphinx-doc-rust-pyo3.yml
@@ -6,10 +6,35 @@ 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: Swatinem/rust-cache@v2
+      - 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
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 This changelog track changes to the qoqo project starting at version v0.5.0
 
+## 1.16.2
+
+### Fixed in 1.16.2
+
+* Added the documentation from qoqo_examples.
+
 ## 1.16.1
 
 ### Fixed in 1.16.1