Infra: Combine manual and examples build #339
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| [submodule "docs/quantinuum-sphinx"] | ||
| path = docs/quantinuum-sphinx | ||
| url = https://github.com/CQCL/quantinuum-sphinx.git | ||
| branch = dist | ||
|
There was a problem hiding this comment. Is this a protected branch? There was a problem hiding this comment. Not sure Is it protected @aidanCQ ? |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| #!/bin/sh | ||
|
|
||
| cd docs/ | ||
|
|
||
| rm -rf build/ | ||
| sphinx-build -b html . build -W | ||
|
|
|
There was a problem hiding this comment. What is this used for? Do we still need it? There was a problem hiding this comment. I don't think this file is needed. |
Empty file.
cqc-melf marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,20 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
|
|
||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta http-equiv="refresh" content="0; url=https://tket.quantinuum.com/user-manual/" /> | ||
| <script type="text/javascript"> | ||
| window.location.href = "https://tket.quantinuum.com/user-manual/" | ||
| </script> | ||
cqc-melf marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <title>TKET docs have moved to tket.quantinuum.com</title> | ||
| </head> | ||
|
|
||
| <body> | ||
| <p> | ||
| If you are not redirected automatically, follow | ||
| <a href="https://tket.quantinuum.com/user-manual/">this link to the user manual on tket.quantinuum.com</a>. | ||
| </p> | ||
| </body> | ||
|
|
||
| </html> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| const navConfig = { | ||
|
|
||
| "navTextLinks": [ | ||
| { | ||
| "title": "API Docs", | ||
| "href": "../api-docs", | ||
| "pathMatch": "somewhere", | ||
| }, | ||
| { | ||
| "title": "Blog", | ||
| "href": "../blog/", | ||
| "pathMatch": "somewhere", | ||
| }, | ||
| { | ||
| "title": "User Guide", | ||
| "href": "../user-guide", | ||
| "pathMatch": "somewhere", | ||
| }, | ||
| ], | ||
| "navProductName": "TKET", | ||
| "navIconLinks": [ | ||
| { | ||
| "title": "TKET Github", | ||
| "href": "https://github.com/CQCL/tket", | ||
| "pathMatch": "somewhere", | ||
| "iconImageURL": "_static/assets/github.svg", | ||
| }, | ||
| { | ||
| "title": "TKET Slack Channel", | ||
| "href": "https://tketusers.slack.com/", | ||
|
There was a problem hiding this comment. Is this a valid invite link? There was a problem hiding this comment. I checked this and it seems to go to the correct page for people not in the workspace. |
||
| "pathMatch": "somewhere", | ||
| "iconImageURL": "_static/assets/slack.svg", | ||
| }, | ||
| { | ||
| "title": "TKET Stack Exchange", | ||
| "href": "https://quantumcomputing.stackexchange.com/questions/tagged/pytket", | ||
| "pathMatch": "somewhere", | ||
| "iconImageURL": "_static/assets/stack.svg", | ||
| }, | ||
| ], | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| # Configuration file for the Sphinx documentation builder. | ||
| # See https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
|
||
| copyright = "2020-2024, Quantinuum" | ||
| author = "Quantinuum" | ||
|
|
||
|
|
||
| html_title = "pytket user guide" | ||
|
|
||
| extensions = [ | ||
| "sphinx.ext.intersphinx", | ||
| "sphinx.ext.mathjax", | ||
| "jupyter_sphinx", | ||
| "sphinx_copybutton", | ||
| "sphinx.ext.autosectionlabel", | ||
| "myst_nb", | ||
| ] | ||
|
|
||
| myst_enable_extensions = ["dollarmath", "html_image", "attrs_inline"] | ||
|
|
||
| html_theme = "furo" | ||
| templates_path = ["./quantinuum-sphinx/_templates/"] | ||
| html_static_path = ["./quantinuum-sphinx/_static/", "_static/"] | ||
|
|
||
| pytketdoc_base = "https://tket.quantinuum.com/api-docs/" | ||
|
|
||
| intersphinx_mapping = { | ||
| "python": ("https://docs.python.org/3/", None), | ||
| "pytket": (pytketdoc_base, None), | ||
| "qiskit": ("https://docs.quantum.ibm.com/api/qiskit", None), | ||
| "pytket-qiskit": ("https://tket.quantinuum.com/extensions/pytket-qiskit/", None), | ||
cqc-melf marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "pytket-quantinuum": ( | ||
| "https://tket.quantinuum.com/extensions/pytket-quantinuum/", | ||
| None, | ||
| ), | ||
| "pytket-qujax": ("https://tket.quantinuum.com/extensions/pytket-qujax/", None), | ||
| "pytket-cirq": ("https://tket.quantinuum.com/extensions/pytket-cirq/", None), | ||
| "sympy": ("https://docs.sympy.org/latest/", None), | ||
| } | ||
|
|
||
|
|
||
| nb_execution_mode = "cache" | ||
|
|
||
| nb_execution_excludepatterns = [ | ||
| "examples/backends/Forest_portability_example.ipynb", | ||
| "examples/backends/backends_example.ipynb", | ||
| "examples/backends/qiskit_integration.ipynb", | ||
| "examples/backends/comparing_simulators.ipynb", | ||
| "examples/algorithms_and_protocols/expectation_value_example.ipynb", | ||
| "examples/algorithms_and_protocols/pytket-qujax_heisenberg_vqe.ipynb", | ||
| "examples/algorithms_and_protocols/pytket-qujax-classification.ipynb", | ||
| "examples/algorithms_and_protocols/pytket-qujax_qaoa.ipynb", | ||
| "examples/algorithms_and_protocols/ucc_vqe.ipynb", | ||
| "examples/algorithms_and_protocols/spam_example.ipynb", | ||
| "examples/algorithms_and_protocols/entanglement_swapping.ipynb", | ||
| ] | ||
|
|
||
| exclude_patterns = ["jupyter_execute/*", ".jupyter_cache", "manual/README.md"] | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you know if there is a reason why we are not using
ubuntu-latest?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure. I can use the latest if you'd prefer?