From d4c2615d3bcfa00ef28c53b01b495f5387fabd8d Mon Sep 17 00:00:00 2001 From: cqc-melf <70640934+cqc-melf@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:13:48 +0000 Subject: [PATCH] Update/dependabot docs (#69) * addtketwebsite * updateextlink * updatedependabot * replaceallgithublinks --- .github/dependabot.yml | 10 +++++++++- .github/workflows/docs/build-docs | 6 ++++-- .github/workflows/docs/conf.py | 2 +- README.md | 6 +++--- setup.py | 2 +- 5 files changed, 18 insertions(+), 8 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ac1560a..f384d36 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -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: + - "*" diff --git a/.github/workflows/docs/build-docs b/.github/workflows/docs/build-docs index b256ac7..875a1ae 100755 --- 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" MODULE = "iqm" PYTKET_IQM_PYPI_LINK = "https://pypi.org/project/pytket-iqm/" PYTKET_IQM_GITHUB = "https://github.com/CQCL/pytket-iqm" @@ -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") diff --git a/.github/workflows/docs/conf.py b/.github/workflows/docs/conf.py index 99c1e64..6872621 100644 --- a/.github/workflows/docs/conf.py +++ b/.github/workflows/docs/conf.py @@ -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, diff --git a/README.md b/README.md index bc24485..297f27d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: diff --git a/setup.py b/setup.py index a4af4aa..37080e6 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ author_email="tket-support@cambridgequantum.com", 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", },