Merge pull request #2 from haiqu-ai/docs_update

Rivet logo added

.github/workflows/documentation.yml

@@ -3,7 +3,6 @@ name: documentation
 on:
   push:
     branches:
-      - docs_public
       - main
 
 permissions:
@@ -42,11 +41,3 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
-
-      # - name: Deploy to GitHub Pages
-      #   uses: peaceiris/actions-gh-pages@v3
-      #   with:
-      #     publish_branch: gh-pages
-      #     github_token: ${{ secrets.GITHUB_TOKEN }}
-      #     publish_dir: _build/
-      #     force_orphan: true

README.md

@@ -1,3 +1,9 @@
+<p align="center">
+<picture>
+  <img src="https://raw.githubusercontent.com/haiqu-ai/rivet/main/docs/source/_static/logos/haiquai_logo.jpeg" width="60%">
+</picture>
+</p>
+
 # Rivet Transpiler
 
 The package provides a family of functions for efficient transpilation of quantum circuits.
@@ -6,7 +12,7 @@ The package provides a family of functions for efficient transpilation of quantu
     - Different transpilation stacks:
         * [Qiskit:](https://github.com/Qiskit/qiskit#readme) Quantum SDK
         * [BQSKit:](https://github.com/BQSKit/bqskit#readme) Berkeley Quantum Synthesis Toolkit
-        * [Pytket:](https://github.com/CQCL/pytket#readme) Python inteface for Quantinuum TKET compiler
+        * [Pytket:](https://github.com/CQCL/pytket#readme) Python interface for Quantinuum TKET compiler
     - Custom PassManager
     - Dynamical decoupling
     - Transpiler options
@@ -123,12 +129,12 @@ ancilla_1 -> 4 ─────────────────────
 
 ## References
 
-We would like to thanks a lot to the:
+We would like to thank to:
 
 * [Qiskit](https://github.com/Qiskit/qiskit) Quantum SDK
 * [BQSKit](https://github.com/BQSKit/bqskit) Berkeley Quantum Synthesis Toolkit
 * [Pytket](https://github.com/CQCL/pytket) Python inteface for Quantinuum TKET compiler
 
 ## Contacts
 
-Haiqu Inc. [[email protected]](mailto:[email protected]),  +1 650 788 6011
+Haiqu Inc. [[email protected]](mailto:[email protected])

docs/source/index.rst

@@ -102,7 +102,7 @@ AFTER transpilation:
 Contacts
 -------------------
 
-Haiqu, [email protected], +1 650 788 6011
+Haiqu, [email protected]
 
 
 .. toctree::
@@ -117,6 +117,6 @@ Haiqu, [email protected], +1 650 788 6011
 .. toctree::
    :maxdepth: 1
    :hidden:
-   :caption: Transpilation Functions
+   :caption: API Reference
 
    api