update links in documentation

CQCL · Nov 22, 2023 · 51262d5 · 51262d5
1 parent a2f3187
commit 51262d5
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/.github/workflows/docs/build-docs b/.github/workflows/docs/build-docs
@@ -10,6 +10,8 @@ import sys
 
 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"
@@ -50,11 +52,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"
         )