,
- baseSourceUrl: string,
+ baseGitHubUrl: string,
): void {
$main.find("a").each((_, a) => {
const $a = $(a);
@@ -177,7 +184,7 @@ export function replaceSourceLinksWithGitHub(
}
//_modules/qiskit_ibm_runtime/ibm_backend
const match = href.match(/_modules\/(.*?)(#|$)/)!;
- const newHref = `${baseSourceUrl}${match[1]}.py`;
+ const newHref = `${baseGitHubUrl}${match[1]}.py`;
$a.attr("href", newHref);
});
}
@@ -256,8 +263,8 @@ export function processMembersAndSetMeta(
.toArray()
.map((child) => {
const $child = $(child);
- $child.find(".viewcode-link").closest("a").remove();
const id = $dl.find("dt").attr("id") || "";
+ const github = prepareGitHubLink($, $child);
const apiType = getApiType($dl);
@@ -273,7 +280,7 @@ export function processMembersAndSetMeta(
if (apiType == "class") {
findByText($, $main, "em.property", "class").remove();
- return `${$child.html()}
`;
+ return `${$child.html()}${github}
`;
}
if (apiType == "property") {
@@ -284,7 +291,7 @@ export function processMembersAndSetMeta(
findByText($, $main, "em.property", "property").remove();
const signature = $child.find("em").text()?.replace(/^:\s+/, "");
if (signature.trim().length === 0) return;
- return `${signature}
`;
+ return `${signature}${github}
`;
}
if (apiType == "method") {
@@ -300,7 +307,7 @@ export function processMembersAndSetMeta(
}
findByText($, $main, "em.property", "method").remove();
- return `${$child.html()}
`;
+ return `${$child.html()}${github}
`;
}
if (apiType == "attribute") {
@@ -312,7 +319,7 @@ export function processMembersAndSetMeta(
findByText($, $main, "em.property", "attribute").remove();
const signature = $child.find("em").text()?.replace(/^:\s+/, "");
if (signature.trim().length === 0) return;
- return `${signature}
`;
+ return `${signature}${github}
`;
}
// Else, the attribute is embedded on the class
@@ -345,12 +352,12 @@ export function processMembersAndSetMeta(
if (apiType === "function") {
findByText($, $main, "em.property", "function").remove();
- return `${$child.html()}
`;
+ return `${$child.html()}${github}
`;
}
if (apiType === "exception") {
findByText($, $main, "em.property", "exception").remove();
- return `${$child.html()}
`;
+ return `${$child.html()}${github}
`;
}
throw new Error(`Unhandled Python type: ${apiType}`);
@@ -361,6 +368,22 @@ export function processMembersAndSetMeta(
}
}
+/**
+ * Removes the original link from sphinx.ext.viewcode and returns the HTML string for our own link.
+ *
+ * This returns the HTML string, rather than directly inserting into the HTML, because the insertion
+ * logic is most easily handled by the calling code.
+ */
+export function prepareGitHubLink($: CheerioAPI, $child: Cheerio): string {
+ const originalLink = $child.find(".viewcode-link").closest("a");
+ if (originalLink.length === 0) {
+ return "";
+ }
+ const href = originalLink.attr("href")!;
+ originalLink.remove();
+ return `GitHub`;
+}
+
export function maybeSetModuleMetadata(
$: CheerioAPI,
$main: Cheerio,