Update/dependabot docs (#72)

* addtketwebsite * updateextlink * updatedependabot * update doc build * update doc build * replaceallgithublinks
CQCL · Nov 21, 2023 · caff2ca · caff2ca
1 parent 2fa2334
commit caff2ca
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 10 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,7 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "daily"
   - package-ecosystem: pip
     directory: "/"
     schedule:

diff --git a/.github/workflows/docs/build-docs b/.github/workflows/docs/build-docs
@@ -10,8 +10,9 @@ import sys
 
 DOCS_DIR = Path(sys.argv[0]).absolute().parent
 MODULES_DIR = DOCS_DIR.parent.parent.parent
-PYTKET_DOCS_LINK = "https://cqcl.github.io/tket/pytket/api/index.html"
-PYTKET_EX_DOCS_LINK = "https://cqcl.github.io/pytket-extensions/api/index.html"
+TKET_WEBSITE_LINK = "https://tket.quantinuum.com/"
+PYTKET_DOCS_LINK = "https://tket.quantinuum.com/api-docs/"
+PYTKET_EX_DOCS_LINK = "https://tket.quantinuum.com/api-docs/extensions.html"
 PYTKET_PENNYLANE_PYPI_LINK = "https://pypi.org/project/pytket-pennylane/"
 PYTKET_PENNYLANE_GITHUB = "https://github.com/CQCL/pytket-pennylane"
 
@@ -51,7 +52,8 @@ def build_module_docs():
         content.append(
             "\n.. toctree::\n\t:caption: More documentation:\n\t:maxdepth: 1\n\n"
         )
-        content.append("\tpytket <https://cqcl.github.io/tket/pytket/api/index.html>\n")
+        content.append(f"\tTKET website <{TKET_WEBSITE_LINK}>\n")
+        content.append("\tpytket <{PYTKET_DOCS_LINK}>\n")
         content.append(f"\tpytket extensions <{PYTKET_EX_DOCS_LINK}>\n")
         content.append(
             "\n.. toctree::\n\t:caption: Links:\n\t:maxdepth: 1\n\n"

diff --git a/.github/workflows/docs/conf.py b/.github/workflows/docs/conf.py
@@ -42,7 +42,7 @@
 
 # -- Extension configuration -------------------------------------------------
 
-pytketdoc_base = "https://cqcl.github.io/tket/pytket/api/"
+pytketdoc_base = "https://tket.quantinuum.com/api-docs/"
 
 intersphinx_mapping = {
     "https://docs.python.org/3/": None,

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # pytket-pennylane
-[Pytket](https://cqcl.github.io/pytket) extension and [PennyLane](https://github.com/PennyLaneAI/pennylane) plugin which allows pytket backends and compilation to be used as a PennyLane device.
+[Pytket](https://tket.quantinuum.com/) extension and [PennyLane](https://github.com/PennyLaneAI/pennylane) plugin which allows pytket backends and compilation to be used as a PennyLane device.
 
 
 Pytket is a quantum SDK python package which provides state of the art compilation for quantum
@@ -15,9 +15,9 @@ cloning and installing from source, or via pip:
 pip install pytket-pennylane
 ```
 
-API documentation is [here](https://cqcl.github.io/pytket-pennylane/api/).
+API documentation is [here](https://tket.quantinuum.com/extensions/pytket-pennylane/api/).
 
-See the PennyLane [documentation](https://pennylane.readthedocs.io) and Pytket [documentation](https://cqcl.github.io/tket/pytket/api/) to get an intro to PennyLane and Pytket.
+See the PennyLane [documentation](https://pennylane.readthedocs.io) and Pytket [documentation](https://tket.quantinuum.com/api-docs/) to get an intro to PennyLane and Pytket.
 
 To use the integration once installed, initialise your pytket backend (in this example, an `AerBackend` which uses Qiskit Aer), and construct a PennyLane `PytketDevice` using this backend:
 
@@ -61,7 +61,7 @@ dev = qml.device(
 )
 ```
 
-You can also use any Pytket [compilation pass](https://cqcl.github.io/pytket/manual/manual_compiler.html) using the `compilation_pass` parameter, which is used instead of the default pass:
+You can also use any Pytket [compilation pass](https://tket.quantinuum.com/user-manual/manual_compiler.html) using the `compilation_pass` parameter, which is used instead of the default pass:
 
 ```python
 from pytket.passes import PauliSimp, SequencePass

diff --git a/setup.py b/setup.py
@@ -21,7 +21,7 @@
     author_email="[email protected]",
     python_requires=">=3.9",
     project_urls={
-        "Documentation": "https://cqcl.github.io/pytket-pennylane/api/index.html",
+        "Documentation": "https://tket.quantinuum.com/extensions/pytket-pennylane/api/index.html",
         "Source": "https://github.com/CQCL/pytket-pennylane",
         "Tracker": "https://github.com/CQCL/pytket-pennylane/issues",
     },