Added missing image

haiqu-ai · Feb 16, 2024 · 42d04f6 · 42d04f6
1 parent 67343d7
commit 42d04f6
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 51 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - docs_public
+      - main
 
 permissions:
   contents: read

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,5 +1,5 @@
-API Reference
-=============
+Transpilation Functions
+=======================
 
 .. automodule:: rivet_transpiler.transpiler
-   :members: transpile, transpile_chain, transpile_right, transpile_left, get_full_map
+   :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -16,7 +16,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "QML Compiler"
+project = "Rivet Transpiler"
 copyright = "2024, Haiqu Inc."  # pylint: disable=redefined-builtin
 author = "Haiqu Inc."
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -117,6 +117,6 @@ Haiqu, info@haiqu.ai, +1 650 788 6011
 .. toctree::
    :maxdepth: 1
    :hidden:
-   :caption: API Reference
+   :caption: Transpilation Functions
 
    api
diff --git a/examples/fourier_adder/fourier_adder.ipynb b/examples/fourier_adder/fourier_adder.ipynb
@@ -821,7 +821,7 @@
     "\n",
     " <br>\n",
     "    <a>\n",
-    "    <img src=\"docs/images/fourier_adder.png\">\n",
+    "    <img src=\"fourier_adder.png\">\n",
     "    </a>\n",
     "<br>"
    ]
@@ -840,30 +840,6 @@
     "\n",
     "![image.png](attachment:abb1fa17-882e-4d05-ac3e-fa7fafd43aee.png)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7fc32194-9082-46a4-81c6-5cd68efe720e",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "cbde53f9-514e-4068-94c4-a796f717d067",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4b7e8450-80ab-4d6d-854d-4a6a441c1400",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

diff --git a/examples/fourier_adder/fourier_adder.png b/examples/fourier_adder/fourier_adder.png
diff --git a/rivet_transpiler/transpiler.py b/rivet_transpiler/transpiler.py
@@ -1,26 +1,5 @@
 """
 Rivet Transpiler functions.
-
-`transpile` - transpilation function featuring:
- - different transpilation stacks:
-    * Qiskit
-    * BQSKit
-    * Pytket
- - custom PassManager
- - dynamical decoupling
- - transpiler options
-
-`transpile_chain` consistently transpile and "stitch" a chain of
-quantum circuits.
-
-`transpile_right` - transpile an additional circuit to the right part of
-the existing circuit.
-
-`transpile_left` - transpile an additional circuit to the left part of
-the existing circuit.
-
-`transpile_and_compress` - transpile and topologically compress a circuit
-considering a coupling map of the selected backend.
 """
 
 import qiskit