From d0948377de2d5a3bf927e8faaaed6e7e492fac75 Mon Sep 17 00:00:00 2001 From: cqc-melf <70640934+cqc-melf@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:21:01 +0000 Subject: [PATCH] Update/dependabot docs (#56) * addtketwebsite * updateextlink * updatedependabot * updatereadme * updatereadmeII * replaceallgithublinks --- .github/dependabot.yml | 10 +++++++++- .github/workflows/docs/build-docs | 6 ++++-- .github/workflows/docs/conf.py | 2 +- .github/workflows/docs/intro.txt | 2 +- README.md | 9 ++------- setup.py | 2 +- 6 files changed, 18 insertions(+), 13 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 a6858a1..ec7cef7 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" PYTKET_QULACS_PYPI_LINK = "https://pypi.org/project/pytket-qulacs/" PYTKET_QULACS_GITHUB = "https://github.com/CQCL/pytket-qulacs" MODULE = "qulacs" @@ -51,6 +52,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( diff --git a/.github/workflows/docs/conf.py b/.github/workflows/docs/conf.py index 68be07d..187bdea 100644 --- a/.github/workflows/docs/conf.py +++ b/.github/workflows/docs/conf.py @@ -33,7 +33,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/.github/workflows/docs/intro.txt b/.github/workflows/docs/intro.txt index 85d4a2c..ce587b0 100644 --- a/.github/workflows/docs/intro.txt +++ b/.github/workflows/docs/intro.txt @@ -6,5 +6,5 @@ platforms. Each extension adds either new methods to the ``pytket`` package to convert between circuit representations, or new backends to which ``pytket`` circuits can be submitted. -.. _pytket: https://cqcl.github.io/tket/pytket/api/ +.. _pytket: https://tket.quantinuum.com/api-docs/ .. _Quantinuum: https://www.quantinuum.com/ diff --git a/README.md b/README.md index b1563de..e8b09be 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,7 @@ -# Pytket Extensions - -This repository contains the pytket-qulacs extension, using Quantinuum's -[pytket](https://cqcl.github.io/tket/pytket/api/index.html) quantum SDK. - # pytket-qulacs -[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a python module for interfacing -with tket, a quantum computing toolkit and optimisation compiler developed by Quantinuum. +[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing +with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum. [Qulacs](https://github.com/qulacs/qulacs) is an open-source quantum circuit simulator designed for large, noisy, and parametric circuits with GPU support diff --git a/setup.py b/setup.py index f160b5d..74554fc 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-qulacs/api/index.html", + "Documentation": "https://tket.quantinuum.com/extensions/pytket-qulacs/api/index.html", "Source": "https://github.com/CQCL/pytket-qulacs", "Tracker": "https://github.com/CQCL/pytket-qulacs/issues", },