Skip to content

Commit

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

* updateextlink

* updatedependabot

* updatereadme

* updatereadmeII

* replaceallgithublinks
  • Loading branch information
cqc-melf authored Nov 21, 2023
1 parent 9ebc45a commit 1216261
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 13 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"
PYTKET_PYQUIL_PYPI_LINK = "https://pypi.org/project/pytket-pyquil/"
PYTKET_PYQUIL_GITHUB = "https://github.com/CQCL/pytket-pyquil"
MODULE = "pyquil"
Expand Down Expand Up @@ -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(
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 @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs/intro.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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/
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Pytket Extensions

This repository contains the pytket-pyquil extension, using Quantinuum's
[pytket](https://cqcl.github.io/tket/pytket/api/index.html) quantum SDK.

# pytket-pyquil

[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.

`pytket-pyquil` is an extension to `pytket` that allows `pytket` circuits to be
run on Rigetti backends and simulators, as well as conversion to and from pyQuil
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="tket-support@cambridgequantum.com",
python_requires=">=3.8",
project_urls={
"Documentation": "https://cqcl.github.io/pytket-pyquil/api/index.html",
"Documentation": "https://tket.quantinuum.com/extensions/pytket-pyquil/api/index.html",
"Source": "https://github.com/CQCL/pytket-pyquil",
"Tracker": "https://github.com/CQCL/pytket-pyquil/issues",
},
Expand Down

0 comments on commit 1216261

Please sign in to comment.