Merge pull request #67 from CQCL/release/pytket-1.15.0

Release/pytket 1.15.0

.github/workflows/build_and_test.yml

@@ -164,4 +164,4 @@ jobs:
     steps:
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v1
+      uses: actions/deploy-pages@v2

.github/workflows/docs/build-docs

@@ -39,9 +39,11 @@ def build_module_docs():
     mod_docs = MODULES_DIR / "docs"
     mod_build = mod_docs / "build"
     conf_copy = mod_docs / "conf.py"
-    logo_copy = mod_docs / "Quantinuum_logo.png"
+    logo_copy_black = mod_docs / "Quantinuum_logo_black.png"
+    logo_copy_white = mod_docs / "Quantinuum_logo_white.png"
     shutil.copy(DOCS_DIR / "conf.py", conf_copy)
-    shutil.copy(DOCS_DIR / "Quantinuum_logo.png", logo_copy)
+    shutil.copy(DOCS_DIR / "Quantinuum_logo_black.png", logo_copy_black)
+    shutil.copy(DOCS_DIR / "Quantinuum_logo_white.png", logo_copy_white)
     remove_dir(mod_build)
     index_rst = mod_docs / "index.rst"
     with open(mod_docs / "intro.txt", "r") as f:
@@ -82,7 +84,8 @@ def build_module_docs():
         fix_links(htmlfile)
     fix_links(mod_build / "searchindex.js")
     conf_copy.unlink()
-    logo_copy.unlink()
+    logo_copy_black.unlink()
+    logo_copy_white.unlink()
     index_rst.unlink()
 
 

.github/workflows/docs/conf.py

@@ -10,9 +10,26 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
+    "sphinx_copybutton",
 ]
 
-html_theme = "sphinx_rtd_theme"
+pygments_style = "borland"
+
+html_theme = "sphinx_book_theme"
+
+html_theme_options = {
+    "repository_url": "https://github.com/CQCL/pytket-braket",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "logo": {
+        "image_light": "Quantinuum_logo_black.png",
+        "image_dark": "Quantinuum_logo_white.png",
+    },
+}
+
+html_static_path = ["_static"]
+
+html_css_files = ["custom.css"]
 
 # -- Extension configuration -------------------------------------------------
 
@@ -29,13 +46,14 @@
 
 # The following code is for resolving broken hyperlinks in the doc.
 
-from sphinx.application import Sphinx
+import re
+from typing import Any, Dict, List, Optional
+from urllib.parse import urljoin
+
 from docutils import nodes
 from docutils.nodes import Element, TextElement
+from sphinx.application import Sphinx
 from sphinx.environment import BuildEnvironment
-from urllib.parse import urljoin
-import re
-from typing import Any, Dict, List, Optional
 
 # Mappings for broken hyperlinks that intersphinx cannot resolve
 external_url_mapping = {

.github/workflows/docs/intro.txt

@@ -1,11 +1,6 @@
 pytket-extensions
 =================
 
-.. image:: Quantinuum_logo.png
-   :width: 160px
-   :align: right
-
-
 These extensions enable `pytket`_ to be used in conjunction with other
 platforms. Each extension adds either new methods to the ``pytket`` package to
 convert between circuit representations, or new backends to which ``pytket``

.github/workflows/docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx ~= 4.3.2
-sphinx_rtd_theme
+sphinx_book_theme >= 1.0.1, <2.0
+sphinx-copybutton

.gitignore

@@ -4,6 +4,7 @@ build
 dist
 *.pyc
 .vscode
+.venv
 .mypy_cache
 .hypothesis
 obj

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.26.0"
+__extension_version__ = "0.27.0"
 __extension_name__ = "pytket-braket"

docs/_static/custom.css

@@ -0,0 +1,35 @@
+.wy-side-nav-search,
+.wy-nav-top {
+    background: #5A46BE;
+}
+
+.wy-grid-for-nav,
+.wy-body-for-nav,
+.wy-nav-side,
+.wy-side-scroll,
+.wy-menu,
+.wy-menu-vertical {
+    background-color: #FFFFFF;
+}
+
+.wy-menu-vertical a:hover {
+    background-color: #d9d9d9;
+}
+
+.btn-link:visited,
+.btn-link,
+a:visited,
+.a.reference.external,
+.a.reference.internal,
+.wy-menu-vertical a,
+.wy-menu-vertical li,
+.wy-menu-vertical ul,
+.span.pre,
+.sig-param,
+html[data-theme=light] {
+    --pst-color-inline-code: rgb(199, 37, 78) !important;
+}
+
+.sig-name {
+    font-size: 1.25rem;
+}

docs/changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 ~~~~~~~~~
 
+
+0.27.0 (May 2023)
+-----------------
+
+* Updated pytket version requirement to 1.15.
+
 0.26.0 (January 2023)
 ---------------------
 

docs/intro.txt

@@ -1,19 +1,6 @@
 pytket-braket
 =============
 
-.. raw:: html
-
-    <embed>
-    <div style="width:100%; display:flex; align-items:center; justify-content:end; transform: translateY(-85px); margin-bottom: -75px">
-        <img src="_images/Quantinuum_logo.png" width="100" height="100"></img>
-    </div>
-    </embed>
-
-.. image:: Quantinuum_logo.png
-   :width: 0px
-   :height: 0px
-   :align: right 
-
 ``pytket-braket`` is an extension to ``pytket`` that allows ``pytket`` circuits to
 be executed on quantum devices and simulators via Amazon's Braket service.
 

setup.py

@@ -43,7 +43,7 @@
     packages=find_namespace_packages(include=["pytket.*"]),
     include_package_data=True,
     install_requires=[
-        "pytket ~= 1.11",
+        "pytket ~= 1.15",
         "amazon-braket-sdk ~= 1.31",
         "amazon-braket-schemas ~= 1.10",
         "amazon-braket-default-simulator ~= 1.9",