Github pages

.github/workflows/documentation.yml

@@ -0,0 +1,51 @@
+name: documentation
+
+on:
+  push:
+    branches:
+      - docs_public
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: |
+          sudo apt update && sudo apt -y install gcc python3-dev pandoc python3-psutil && pip install sphinx matplotlib ipywidgets nbsphinx pylatexenc sphinx-pdj-theme myst_parser
+
+      - name: Sphinx build
+        run: |
+          python3 -m sphinx -b html ./docs/source _build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./_build"
+
+      - 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

@@ -20,7 +20,7 @@ The package provides a family of functions for efficient transpilation of quantu
 To install Rivet Transpiler, please clone the repository:
 
 ```bash
-git clone https://gitlab.com/haiqu-ai/qml-transpiler.git
+git clone https://github.com/haiqu-ai/rivet.git
 ```
 
 To install the transpiler with all supported stacks:
@@ -38,7 +38,7 @@ pip install .[pytket]
 
 ## Documentation
 
-For more details about the Rivet Transpiler, please check the [reference documentation](https://haiqu-ai.gitlab.io/qml-transpiler).
+For more details about the Rivet Transpiler, please check the [reference documentation](https://haiqu-ai.github.io/rivet).
 
 
 ## Tutorials

docs/source/index.rst

@@ -17,7 +17,7 @@ To install Rivet Transpiler, please clone the repository:
 
 .. code-block:: bash
 
-   git clone https://gitlab.com/haiqu-ai/qml-transpiler.git
+   git clone https://github.com/haiqu-ai/rivet.git
 
 To install the transpiler with all supported stacks:
 

pyproject.toml

@@ -6,7 +6,7 @@
 [project]
 
     name = "rivet-transpiler"
-    description = "Rivet Transpiler"
+    description = "Rivet Transpiler provides a family of functions for efficient transpilation of quantum circuits."
     readme = "README.md"
     authors = [{ name = "Haiqu Inc.", email = "info@haiqu.ai" }]
     license = { file = "LICENSE" }
@@ -43,7 +43,7 @@
     ]
 
 [project.urls]
-    Homepage = "https://haiqu-ai.gitlab.io/qml-transpiler"
+    Homepage = "https://github.com/haiqu-ai/rivet"
 
 [project.optional-dependencies]