Merge remote-tracking branch 'origin/main' into md/final_doc_review

.github/workflows/build_docs.yml

@@ -0,0 +1,56 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch: {}
+
+concurrency:
+  group: docs-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test_qadence_ubuntu:
+    name: Test Qadence docs (ubuntu)
+    runs-on: ubuntu-22.04
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - name: Install JetBrains Mono font
+      run: |
+        sudo apt install -y wget unzip fontconfig
+        wget https://download.jetbrains.com/fonts/JetBrainsMono-2.304.zip
+        unzip JetBrainsMono-2.304.zip -d JetBrainsMono
+        mkdir -p /usr/share/fonts/truetype/jetbrains
+        cp JetBrainsMono/fonts/ttf/*.ttf /usr/share/fonts/truetype/jetbrains/
+        fc-cache -f -v
+
+    - name: Install graphviz
+      run: sudo apt-get install -y graphviz
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install Hatch
+      run: |
+        pip install hatch
+
+    - name: Build docs
+      if: ${{ !startsWith(github.ref, 'ref/tags/v') }}
+      run: |
+        hatch -v run docs:build
+
+    - name: Deploy docs
+      if: startsWith(github.ref, 'ref/tags/v')
+      run: |
+        echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+        git config user.name "GitHub Actions"
+        git config user.email "[email protected]"
+        mike deploy --push --update-aliases $VERSION latest

README.md

@@ -26,7 +26,7 @@ programs**_ with tunable interaction defined on _**arbitrary qubit register layo
 * `QuantumModel`s to make `QuantumCircuit`s differentiable and runnable on a variety of different
   backends like state vector simulators, tensor network emulators and real devices.
 
-Documentation can be found here: [https://pasqal-qadence.readthedocs-hosted.com/en/latest](https://pasqal-qadence.readthedocs-hosted.com/en/latest).
+Documentation can be found here: [https://pasqal-io.github.io/qadence/latest/](https://pasqal-io.github.io/qadence/latest/).
 
 
 ## Citation

docs/index.md

@@ -13,7 +13,7 @@ realizable on neutral atom devices.
 
 * An intuitive [expression-based system](tutorials/parameters.md) developed on top of the symbolic library [Sympy](https://www.sympy.org/en/index.html) to construct _**parametric quantum programs**_ easily.
 
-* [High-order generalized parameter shift rules](link to psr tutorial) for _**differentiating parametrized quantum operations**_.
+* [High-order generalized parameter shift rules](advanced_tutorials/differentiability.md) for _**differentiating parametrized quantum operations**_.
 
 * Out-of-the-box _**automatic differentiability**_ of quantum programs with [PyTorch](https://pytorch.org/) integration.
 

mkdocs.yml

@@ -1,5 +1,6 @@
 site_name: Qadence
-repo_url: "https://gitlab.pasqal.com/pqs/qadence"
+repo_url: "https://github.com/pasqal-io/qadence/"
+site_url: "https://pasqal-io.github.io/qadence/"
 repo_name: "qadence"
 
 nav:
@@ -131,6 +132,10 @@ plugins:
 
 - markdown-exec
 
+extra:
+ version:
+   provider: mike
+
 # To get nice tabs
 extra_css:
 - css/mkdocstrings.css

pyproject.toml

@@ -118,6 +118,7 @@ dependencies = [
   "mkdocs-section-index==0.3.6",
   "mkdocs-exclude",
   "markdown-exec",
+  "mike",
 ]
 features = ["pulser", "braket", "visualization"]