From 4db52a01af2798730c87dc897ae7afab3c026ad1 Mon Sep 17 00:00:00 2001 From: cqc-melf <70640934+cqc-melf@users.noreply.github.com> Date: Fri, 24 Nov 2023 08:59:02 +0000 Subject: [PATCH] update links in documentation (#211) * update links in documentation * update readme --- .github/workflows/docs/build-docs | 10 +++++++--- README.md | 4 +++- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs/build-docs b/.github/workflows/docs/build-docs index cfa65f3f..2372b5c6 100755 --- a/.github/workflows/docs/build-docs +++ b/.github/workflows/docs/build-docs @@ -10,6 +10,8 @@ from pathlib import Path DOCS_DIR = Path(sys.argv[0]).absolute().parent MODULES_DIR = DOCS_DIR.parent.parent.parent +TKET_EXAMPLES_LINK = "https://tket.quantinuum.com/examples/" +TKET_MANUAL_LINK = "https://tket.quantinuum.com/user-manual/" 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" @@ -51,11 +53,13 @@ def build_module_docs(): with open(mod_docs / "intro.txt", "r") as f: content = f.readlines() content.append( - "\n.. toctree::\n\t:caption: More documentation:\n\t:maxdepth: 1\n\n" + "\n.. toctree::\n\t:caption: pytket 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 API docs <{PYTKET_DOCS_LINK}>\n") content.append(f"\tpytket extensions <{PYTKET_EX_DOCS_LINK}>\n") + content.append(f"\tManual <{TKET_MANUAL_LINK}>\n") + content.append(f"\tExample notebooks <{TKET_EXAMPLES_LINK}>\n") + content.append(f"\tTKET website <{TKET_WEBSITE_LINK}>\n") content.append("\n.. toctree::\n\t:caption: Links:\n\t:maxdepth: 1\n\n") content.append(f"\tbug tracker <{PYTKET_QISKIT_GITHUB}/issues>\n") content.append(f"\tGitHub <{PYTKET_QISKIT_GITHUB}>\n") diff --git a/README.md b/README.md index 9e7bb87c..3d848573 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ representations. `pytket-qiskit` is available for Python 3.9, 3.10 and 3.11, on Linux, MacOS and Windows. To install, run: -```pip install pytket-qiskit``` +```shell +pip install pytket-qiskit +``` This will install `pytket` if it isn't already installed, and add new classes and methods into the `pytket.extensions` namespace.