Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing metadata for Qiskit Transpiler Service #1438

Merged
merged 13 commits into from
May 28, 2024
Merged

Add missing metadata for Qiskit Transpiler Service #1438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2aa5c7a
Add missing metadata to Qiskit Transpiler Service index
Eric-Arellano May 28, 2024
5b8a670
Regenerate qiskit-ibm-runtime 0.14.0
Eric-Arellano May 28, 2024
faef9ea
Regenerate qiskit-ibm-runtime 0.15.0
Eric-Arellano May 28, 2024
63b256e
Regenerate qiskit-ibm-runtime 0.16.1
Eric-Arellano May 28, 2024
d51aa85
Regenerate qiskit-ibm-runtime 0.17.0
Eric-Arellano May 28, 2024
3c7897e
Regenerate qiskit-ibm-runtime 0.18.0
Eric-Arellano May 28, 2024
c5e5332
Regenerate qiskit-ibm-runtime 0.19.1
Eric-Arellano May 28, 2024
8bf63a9
Regenerate qiskit-ibm-runtime 0.20.0
Eric-Arellano May 28, 2024
770ba80
Regenerate qiskit-ibm-runtime 0.21.1
Eric-Arellano May 28, 2024
ce9e61b
Regenerate qiskit-ibm-runtime 0.22.0
Eric-Arellano May 28, 2024
f1bb3f3
Regenerate qiskit-ibm-runtime 0.23.0
Eric-Arellano May 28, 2024
f1e94ae
Regenerate qiskit-ibm-runtime 0.24.0-dev
Eric-Arellano May 28, 2024
bb8901c
Fix dev version of docs
Eric-Arellano May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.14/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.15/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.16/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.17/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.18/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.19/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.20/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.21/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.22/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/dev/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime
description: API documentation for the qiskit-ibm-runtime client
---

# qiskit-ibm-runtime API reference
Expand Down
6 changes: 6 additions & 0 deletions docs/api/qiskit-transpiler-service/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
---
title: Qiskit Transpiler Service Client Docs
description: API documentation for the qiskit-transpiler-service client
---

# qiskit-transpiler-service API reference

* [AI (`qiskit_transpiler_service.ai`)](ai)
* [Qiskit Transpiler Service (`qiskit_transpiler_service.transpiler_service`)](transpiler_service)
* [Utilities (`qiskit_transpiler_service.utils`)](utils)

15 changes: 14 additions & 1 deletion scripts/lib/api/specialCaseResults.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,14 @@
import { HtmlToMdResultWithUrl } from "./HtmlToMdResult";

export const RUNTIME_INDEX_META = `title: Qiskit Runtime IBM Client API Docs
description: API documentation for qiskit-ibm-runtime`;
description: API documentation for the qiskit-ibm-runtime client`;

export const PROVIDER_INDEX_META = `title: Qiskit IBM Provider API Docs
description: API documentation for qiskit-ibm-provider`;

export const TRANSPILER_SERVICE_INDEX_META = `title: Qiskit Transpiler Service Client Docs
description: API documentation for the qiskit-transpiler-service client`;

export function transformSpecialCaseUrl(url: string): string {
return (
url
Expand Down Expand Up @@ -46,6 +49,16 @@ export function specialCaseResults(results: HtmlToMdResultWithUrl[]): void {
hardcodedFrontmatter: RUNTIME_INDEX_META,
};
}

if (
result.url.endsWith("/index") &&
result.url.includes("qiskit-transpiler-service/")
Comment on lines +54 to +55
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this check is so that we will still match on qiskit-transpiler-service/dev/index

) {
result.meta = {
hardcodedFrontmatter: TRANSPILER_SERVICE_INDEX_META,
};
}

result.url = transformSpecialCaseUrl(result.url);
}
}
Loading