From da3aebc50d4e52b4b3255c8f10084c18615dfbfd Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Thu, 10 Aug 2023 10:32:24 +0100 Subject: [PATCH] Add the link to the pytket-cutensornet docs (#519) * add cutensornet link * append link to content * update copyright * remove import --- .github/workflows/docs/build-docs | 5 ++--- .github/workflows/docs/conf.py | 6 ++---- README.md | 1 + dev-utils/generate_mgit.sh | 4 ++-- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docs/build-docs b/.github/workflows/docs/build-docs index 71fe45af..799470a9 100755 --- a/.github/workflows/docs/build-docs +++ b/.github/workflows/docs/build-docs @@ -1,7 +1,6 @@ #!/usr/bin/env python import argparse -import datetime from pathlib import Path import shutil import subprocess @@ -26,6 +25,7 @@ PYTKET_QIR_DOCS_LINK = "https://cqcl.github.io/pytket-qir/api/index.html" PYTKET_QISKIT_DOCS_LINK = "https://cqcl.github.io/pytket-qiskit/api/index.html" PYTKET_QSHARP_DOCS_LINK = "https://cqcl.github.io/pytket-qsharp/api/index.html" PYTKET_QUANTINUUM_DOCS_LINK = "https://cqcl.github.io/pytket-quantinuum/api/index.html" +PYTKET_CUTENSORNET_LINK = "https://cqcl.github.io/pytket-cutensornet/api/index.html" PYTKET_QULACS_DOCS_LINK = "https://cqcl.github.io/pytket-qulacs/api/index.html" PYTKET_QUJAX_DOCS_LINK = "https://cqcl.github.io/pytket-qujax/api/index.html" PYTKET_STIM_DOCS_LINK = "https://cqcl.github.io/pytket-stim/api/index.html" @@ -83,6 +83,7 @@ if __name__ == "__main__": content.append(f"\tpytket-qiskit <{PYTKET_QISKIT_DOCS_LINK}>\n") content.append(f"\tpytket-qsharp <{PYTKET_QSHARP_DOCS_LINK}>\n") content.append(f"\tpytket-quantinuum <{PYTKET_QUANTINUUM_DOCS_LINK}>\n") + content.append(f"\tpytket-cutensornet <{PYTKET_CUTENSORNET_LINK}>\n") content.append(f"\tpytket-qulacs <{PYTKET_QULACS_DOCS_LINK}>\n") content.append(f"\tpytket-qujax <{PYTKET_QUJAX_DOCS_LINK}>\n") content.append(f"\tpytket-stim <{PYTKET_STIM_DOCS_LINK}>\n") @@ -105,8 +106,6 @@ if __name__ == "__main__": "-D", f"project=pytket-extensions", "-D", - f"copyright={datetime.date.today().year} Cambridge Quantum Computing", - "-D", "templates_path=templates", ".", "build", diff --git a/.github/workflows/docs/conf.py b/.github/workflows/docs/conf.py index 3bfcab6a..0508eb4c 100644 --- a/.github/workflows/docs/conf.py +++ b/.github/workflows/docs/conf.py @@ -3,7 +3,8 @@ # Configuration file for the Sphinx documentation builder. # See https://www.sphinx-doc.org/en/master/usage/configuration.html -author = "Cambridge Quantum Computing Ltd" +copyright = "2023 Quantinuum" +author = "Quantinuum" extensions = [ "sphinx.ext.autodoc", @@ -13,8 +14,6 @@ "sphinx_copybutton", ] -pygments_style = "borland" - html_theme = "sphinx_book_theme" html_theme_options = { @@ -116,7 +115,6 @@ def correct_signature( signature: str, return_annotation: str, ) -> (str, str): - new_signature = signature new_return_annotation = return_annotation for k, v in app.config.custom_internal_mapping.items(): diff --git a/README.md b/README.md index 91cfdfdc..47b9a571 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ The extensions can be found in other repos: * [pytket-qiskit](https://github.com/CQCL/pytket-qiskit) * [pytket-qsharp](https://github.com/CQCL/pytket-qsharp) * [pytket-quantinuum](https://github.com/CQCL/pytket-quantinuum) +* [pytket-cutensornet](https://github.com/CQCL/pytket-cutensornet) * [pytket-qujax](https://github.com/CQCL/pytket-qujax) * [pytket-qulacs](https://github.com/CQCL/pytket-qulacs) * [pytket-stim](https://github.com/CQCL/pytket-stim) diff --git a/dev-utils/generate_mgit.sh b/dev-utils/generate_mgit.sh index 02e585fd..5c8da33c 100644 --- a/dev-utils/generate_mgit.sh +++ b/dev-utils/generate_mgit.sh @@ -16,8 +16,8 @@ echo "#!/bin/bash" > mgitrename.sh echo "#!/bin/bash" > mgitcopy.sh # choose the list of the extensions you want to use -# list of all extensions: "aqt" "braket" "cirq" "ionq" "iqm" "pennylane" "projectq" "pyquil" "pysimplex" "pyzx" "qir" "qiskit" "qsharp" "quantinuum" "qulacs" "qujax" "stim" -for ext in "aqt" "braket" "cirq" "ionq" "iqm" "pennylane" "projectq" "pyquil" "pysimplex" "pyzx" "qir" "qiskit" "qsharp" "quantinuum" "qulacs" "qujax" "stim" +# list of all extensions: "aqt" "braket" "cirq" "ionq" "iqm" "pennylane" "projectq" "pyquil" "pysimplex" "pyzx" "qir" "qiskit" "qsharp" "quantinuum" "cutensornet" "qulacs" "qujax" "stim" +for ext in "aqt" "braket" "cirq" "ionq" "iqm" "pennylane" "projectq" "pyquil" "pysimplex" "pyzx" "qir" "qiskit" "qsharp" "quantinuum" "cutensornet" "qulacs" "qujax" "stim" do echo "git clone git@github.com:CQCL/pytket-$ext.git" >> mgitclone.sh