Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/dependabot docs #60

Merged
merged 6 commits into from
Nov 21, 2023
Merged

Update/dependabot docs #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ea6bf7d
addtketwebsite
cqc-melf Nov 21, 2023
fe480b5
updateextlink
cqc-melf Nov 21, 2023
7c83c5d
updatedependabot
cqc-melf Nov 21, 2023
ff81ae2
updatereadme
cqc-melf Nov 21, 2023
3f06be8
updatereadmeII
cqc-melf Nov 21, 2023
e495890
replaceallgithublinks
cqc-melf Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@

version: 2
updates:
- package-ecosystem: github-actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: weekly
interval: "daily"
- package-ecosystem: pip
directory: "/"
schedule:
interval: weekly
interval: "daily"
groups:
python-packages:
patterns:
- "*"
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
# Pytket Extensions

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

# pytket-aqt

[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-aqt` is an extension to `pytket` that allows `pytket` circuits to be
executed on AQT's ([Alpine Quantum Technologies'](https://www.aqt.eu/)) quantum devices and simulators.

See [extension documentation](https://cqcl.github.io/pytket-aqt/api/index.html) for more.
See [extension documentation](https://tket.quantinuum.com/extensions/pytket-aqt/api/index.html) for more.

## Getting started

Expand Down
6 changes: 4 additions & 2 deletions docs/build-docs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ from pathlib import Path
from typing import Any

DOCS_DIR = Path(sys.argv[0]).absolute().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_AQT_PYPI_LINK = "https://pypi.org/project/pytket-aqt/"
PYTKET_AQT_GITHUB = "https://github.com/CQCL/pytket-aqt"
MODULE = "aqt"
Expand Down Expand Up @@ -44,6 +45,7 @@ def build_module_docs() -> None:
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 docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,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 pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ license = "Apache 2"
readme = "README.md"
packages = [{include = "pytket"}]
repository = "https://github.com/CQCL/pytket-aqt"
documentation = "https://cqcl.github.io/pytket-aqt/api/index.html"
documentation = "https://tket.quantinuum.com/extensions/pytket-aqt/api/index.html"
classifiers= [
"Environment :: Console",
"Programming Language :: Python :: 3.10",
Expand Down