From 7d7186e6edf51d44de36a08a3a119df10bccc0f7 Mon Sep 17 00:00:00 2001 From: Melf Date: Wed, 22 Nov 2023 16:20:25 +0000 Subject: [PATCH] update links in documentation --- .github/workflows/docs/build-docs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 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")