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

Jump to bottom

Update/dependabot docs #35

Merged
merged 6 commits into from
Nov 21, 2023
Merged

Update/dependabot docs #35

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d3eac7e
addtketwebsite
cqc-melf Nov 21, 2023
1ad0b03
updateextlink
cqc-melf Nov 21, 2023
0cf0642
updatedependabot
cqc-melf Nov 21, 2023
e78a735
updatereadme
cqc-melf Nov 21, 2023
26f7a65
updatereadmeII
cqc-melf Nov 21, 2023
4352e7e
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: 9 additions & 1 deletion .github/dependabot.yml
View file
Open in desktop
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
View file
Open in desktop
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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong URL?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean this one? https://tket.quantinuum.com/api-docs/extensions.html

That is correct, but not working yet. It will work after the next pytket release.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The https://tket.quantinuum.com/api-docs/extensions.html page isn't deployed yet but should be after the next pytket release.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CalMacCQ can you confirm this?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that one. OK

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the the URL you gave is correct. The extensions index is now part of the API docs. This link should work when the tket-site is redeployed after the next pytket release.

PYTKET_STIM_PYPI_LINK = "https://pypi.org/project/pytket-stim/"
PYTKET_STIM_GITHUB = "https://github.com/CQCL/pytket-stim"
MODULE = "stim"
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
7 changes: 1 addition & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Pytket Extensions

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

# pytket-stim

[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a python module for interfacing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't you say you wanted to get rid of this line from the README as well?

If you keep this sentance I'd suggest using "optimising" instead of "optimisation"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated that now

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that we are using the https://tket.quantinuum.com/api-docs/ link above, it would make sense to update this as well I think.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

with tket, a quantum computing toolkit and optimisation compiler developed by Quantinuum.
with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.

[Stim](https://github.com/quantumlib/Stim) is a fast Clifford circuit simulator.

Expand Down