Add functions API docs to preview and linter checks

qiskit_bot.yaml

@@ -9,6 +9,42 @@ notification_prelude: |
 # we still want their name in the Qiskit Bot message so people know they are
 # relevant.
 notifications:
+  "docs/api/functions/_toc":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/algorithmiq-tem":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/colibritd-pde":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/global-data-quantum-optimizer":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/ibm-circuit-function":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/index":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/kipu-optimization":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/multiverse-computing-singularity":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/q-ctrl-optimization-solver":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/q-ctrl-performance-management":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/qedma-qesem":
+    - "`@abbycross`"
+    - "`@kaelynj`"
+  "docs/api/functions/qunova-chemistry":
+    - "`@abbycross`"
+    - "`@kaelynj`"
   "docs/guides/support":
     - "`@abbycross`"
     - "`@beckykd`"

scripts/js/commands/checkOrphanPages.ts

@@ -86,9 +86,11 @@ async function findExistentUrls(directory: string): Promise<string[]> {
 
 async function findTocFiles(includeApis: boolean): Promise<string[]> {
   const globs = [
-    "{docs,learning}/**/_toc.json",
-    includeApis ? "docs/api/**/_toc.json" : "!docs/api/**",
-  ];
+    ["{docs,learning}/**/_toc.json"],
+    includeApis
+      ? ["docs/api/**/_toc.json"]
+      : ["!docs/api/**", "docs/api/functions/_toc.json"],
+  ].flat();
   return globby(globs);
 }
 

scripts/js/commands/checkQiskitBotFiles.ts

@@ -47,7 +47,11 @@ const ALLOWED_OWNERLESS_FILES = new Set([
 
 const ALLOWED_NONEXISTENT_FILES: Set<string> = new Set([]);
 
-const GLOBS = ["{docs,learning}/**/*.{ipynb,mdx}", "!docs/api/**/*"];
+const GLOBS = [
+  "{docs,learning}/**/*.{ipynb,mdx}",
+  "!docs/api/**/*",
+  "docs/api/functions/**",
+];
 
 async function main() {
   const qiskitBotFiles = await getQiskitBotFiles();

start

@@ -14,6 +14,7 @@
 import subprocess
 import sys
 from pathlib import Path
+from typing import Iterable
 
 # Get the latest digest by running `docker pull icr.io/qc-open-source-docs-public/preview:latest`.
 IMAGE_DIGEST = "sha256:5336ed8710d3822e6409381e7c4a6d60d7860a2228e22a0f2b2de26c68f54a0b"
@@ -25,12 +26,16 @@ PWD = Path(__file__).parent.as_posix()
 IMAGE = f"icr.io/qc-open-source-docs-public/preview@{IMAGE_DIGEST}"
 
 
-def skip_apis() -> tuple[str]:
+def skip_apis(working_directory: str) -> Iterable[str]:
     """Mounts an empty directory to /docs/api/ to effectively exclude it"""
     if "--apis" in sys.argv:
         return ()
-    print("Skipping API docs for speed; use --apis to include them")
-    return ("-v", "/home/node/app/docs/api")
+    print("Skipping non-functions API docs for speed; use --apis to include them")
+    return (
+        "-v", "/home/node/app/docs/api",
+        # Even when skipping APIs, we still include the functions APIs
+        "-v", f"{working_directory}/docs/api/functions:/home/node/app/docs/api/functions"
+    )
 
 def main() -> None:
     if "--pull-only" in sys.argv:
@@ -45,7 +50,7 @@ def main() -> None:
         f"{PWD}/docs:/home/node/app/content/docs",
         "-v",
         f"{PWD}/learning:/home/node/app/content/learning",
-        *skip_apis(),
+        *skip_apis(PWD),
         "-v",
         f"{PWD}/public:/home/node/app/packages/preview/public",
         "-p",