Skip to content

Commit

Permalink
Update/dependabot docs (#69)
Browse files Browse the repository at this point in the history
* addtketwebsite

* updateextlink

* updatedependabot

* replaceallgithublinks
  • Loading branch information
cqc-melf authored Nov 21, 2023
1 parent 37d096d commit d4c2615
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 8 deletions.
10 changes: 9 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,12 @@ updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
interval: "daily"
- package-ecosystem: pip
directory: "/"
schedule:
interval: "daily"
groups:
python-packages:
patterns:
- "*"
6 changes: 4 additions & 2 deletions .github/workflows/docs/build-docs
Original file line number Diff line number Diff line change
Expand Up @@ -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"
MODULE = "iqm"
PYTKET_IQM_PYPI_LINK = "https://pypi.org/project/pytket-iqm/"
PYTKET_IQM_GITHUB = "https://github.com/CQCL/pytket-iqm"
Expand Down Expand Up @@ -52,6 +53,7 @@ def build_module_docs():
content.append(
"\n.. toctree::\n\t:caption: More documentation:\n\t:maxdepth: 1\n\n"
)
content.append(f"\tTKET website <{TKET_WEBSITE_LINK}>\n")
content.append(f"\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")
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,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,
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pytket-iqm

[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a python module
[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module
providing an extensive set of tools for compiling and executing quantum circuits.

`pytket-iqm` is an extension to `pytket` that allows `pytket` circuits to be
Expand All @@ -19,11 +19,11 @@ This will install `pytket` if it isn't already installed, and add new classes
and methods into the `pytket.extensions` namespace.

API documentation is available
[here](https://cqcl.github.io/pytket-iqm/api/index.html).
[here](https://tket.quantinuum.com/extensions/pytket-iqm/api/index.html).

Under the hood, `pytket-iqm` uses `iqm-client` to interact with the devices. See
the IQM Client [documentation](https://iqm-finland.github.io/iqm-client/) and
Pytket [documentation](https://cqcl.github.io/tket/pytket/api/) for more info.
Pytket [documentation](https://tket.quantinuum.com/api-docs/) for more info.

To use the integration, initialise an `IQMBackend`, construct a Pytket circuit,
compile it and run. Here is a small example of running a GHZ state circuit:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
author_email="[email protected]",
python_requires=">=3.9",
project_urls={
"Documentation": "https://cqcl.github.io/pytket-iqm/api/index.html",
"Documentation": "https://tket.quantinuum.com/extensions/pytket-iqm/api/index.html",
"Source": "https://github.com/CQCL/pytket-iqm",
"Tracker": "https://github.com/CQCL/pytket-iqm/issues",
},
Expand Down

0 comments on commit d4c2615

Please sign in to comment.