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

Improve the API script to handle | characters #718

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Improve the API script to handle | characters #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 43 additions & 2 deletions scripts/lib/api/htmlToMd.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,7 +1042,7 @@ bits.</p>
<div role='main'>
<div class="math notranslate nohighlight">
\\[\\begin{split}CCX q_0, q_1, q_2 =
I \\otimes I \\otimes |0 \\rangle \\langle 0| + CX \\otimes |1 \\rangle \\langle 1| =
I \\otimes I \\otimes \vert 0 \\rangle \\langle 0\vert + CX \\otimes \vert 1 \\rangle \\langle 1\vert =
\\begin{pmatrix}
1 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0\\\\
0 &amp; 1 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0\\\\
Expand All @@ -1061,7 +1061,7 @@ bits.</p>
).toMatchInlineSnapshot(`
"$$
\\begin{split}CCX q_0, q_1, q_2 =
I \\otimes I \\otimes |0 \\rangle \\langle 0| + CX \\otimes |1 \\rangle \\langle 1| =
I \\otimes I \\otimes \vert 0 \\rangle \\langle 0\vert + CX \\otimes \vert 1 \\rangle \\langle 1\vert =
\\begin{pmatrix}
1 & 0 & 0 & 0 & 0 & 0 & 0 & 0\\\\
0 & 1 & 0 & 0 & 0 & 0 & 0 & 0\\\\
Expand Down Expand Up @@ -1427,6 +1427,47 @@ test("test dt tag without id", async () => {
`);
});

test("test replacement of the pipe character for `\vert` on math expressions", async () => {
expect(
await toMd(`
<div role="main">
<p class="rubric">Methods</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><a class="reference internal" href="#text-with-pipe" title="text with pipe"></td>
<td><p>This is an example of using the | character outside of a math expression</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#span-tag-math-expressions-with-pipe" title="(span tag) math expressions with pipe"></a></td>
<td><p>Example single pipe: <span class="math">\\(\\mathcal{Q}^k \\mathcal{A} |0\\rangle\\)</span>.</p></td>
<tr class="row-odd"><td><a class="reference internal" href="#span-tag-math-expressions-with-double-pipe" title="(span tag) math expressions with double pipe"></a></td>
<td><p>Example double pipe: The length of the vector x is <span class="math">\\(\\|x\\|_2\\)</span>.</p></td>
</tbody>
</table>
<p>This is a math expression outside the table: <div class="math">\\[\\mathcal{Q}^k \\mathcal{A} |0\\rangle\\]</div></p>
</div>
`),
).toMatchInlineSnapshot(`
"## Methods

| | |
| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [](#text-with-pipe "text with pipe") | This is an example of using the \\| character outside of a math expression |
| [](#span-tag-math-expressions-with-pipe "(span tag) math expressions with pipe") | Example single pipe: $\\mathcal{Q}^k \\mathcal{A} \\vert 0\\rangle$. |
| [](#span-tag-math-expressions-with-double-pipe "(span tag) math expressions with double pipe") | Example double pipe: The length of the vector x is $\\|x\\|_2$. |

This is a math expression outside the table:

$$
\\mathcal{Q}^k \\mathcal{A} \\vert 0\\rangle
$$
"
`);
});

async function toMd(html: string) {
return (
await sphinxHtmlToMarkdown({
Expand Down
6 changes: 6 additions & 0 deletions scripts/lib/api/htmlToMd.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ async function generateMarkdownFile(
const sufix = "\\)";
if (value.startsWith(prefix) && value.endsWith(sufix)) {
value = value.substring(prefix.length, value.length - sufix.length);
// We need to replace the single `|` characters for `\vert ` to avoid page crashes when
// they are used inside a table. For more information: https://github.com/Qiskit/documentation/issues/488
value = value.replace(/(?<!\\)\|/gm, "\\vert ");
}
return { type: "inlineMath", value };
}
Expand All @@ -92,6 +95,9 @@ async function generateMarkdownFile(
const sufix = "\\]";
if (value.startsWith(prefix) && value.endsWith(sufix)) {
value = value.substring(prefix.length, value.length - sufix.length);
// We need to replace the single `|` characters for `\vert ` to avoid page crashes when
// they are used inside a table. For more information: https://github.com/Qiskit/documentation/issues/488
value = value.replace(/(?<!\\)\|/gm, "\\vert ");
}
return { type: "math", value };
}
Expand Down
Loading