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.

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 #35

Merged
merged 6 commits into from
Nov 21, 2023
Merged

Update/dependabot docs #35

merged 6 commits into from
Nov 21, 2023

Conversation

cqc-melf
Copy link
Collaborator

I will suggest that we discuss the changes here, I will open the other PRs shortly.

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.

cqc-alec
cqc-alec previously approved these changes Nov 21, 2023
README.md Outdated

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

cqc-alec
cqc-alec previously approved these changes Nov 21, 2023
README.md Outdated

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.

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

@cqc-melf cqc-melf merged commit 139dc4d into develop Nov 21, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants