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

Jump to bottom

Fix regressions in API generation script #67

Closed
Eric-Arellano opened this issue Oct 2, 2023 · 1 comment · Fixed by #222
Closed

Fix regressions in API generation script #67

Eric-Arellano opened this issue Oct 2, 2023 · 1 comment · Fixed by #222
Assignees
@Eric-Arellano
Labels
infra 🏗️
Milestone
mid-oct release

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Oct 2, 2023 •
edited
Loading

Detected in #68.

in qiskit alt text

documentation/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md

Line 17 in ab783b4

You can run experiments on a backend using the [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit.html#qiskit.circuit.QuantumCircuit "(in Qiskit v0.44)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow:

Note the "(in Qiskit v0.44)" text.

I'm not sure what is expected? This is how https://qiskit.org/ecosystem/ibm-provider/stubs/qiskit_ibm_provider.IBMBackend.html#qiskit_ibm_provider.IBMBackend renders:

Screenshot 2023-10-02 at 5 26 57 PM

This is not a bug. It's intentional and sets the HTML anchor title.

IBM Runtime no TOC children (fixed in #221)

documentation/docs/api/qiskit-ibm-runtime/_toc.json

Lines 4 to 9 in ab783b4

"children": [
{
"title": "Changelog",
"url": "https://github.com/qiskit/qiskit-ibm-runtime/releases"
}
]

IBM runtime missing header (fixed in #221)

documentation/docs/api/qiskit-ibm-runtime/options.md

Line 1 in ab783b4

<span id="primitive-options-qiskit-ibm-runtime-options" />

Was originally:

---
title: options
description: API reference for qiskit_ibm_runtime.options
in_page_toc_min_heading_level: 1
python_api_type: module
python_api_name: qiskit_ibm_runtime.options
---

IBM runtime bad headers (fixed in #212)

Shouldn't have the [¶] character.

documentation/docs/api/qiskit-ibm-runtime/ibm-runtime.md

Line 1 in ab783b4

# qiskit-ibm-runtime API reference[](#qiskit-ibm-runtime-api-reference "Link to this heading")

@Eric-Arellano Eric-Arellano added this to the Infra MVP fast-follow milestone Oct 2, 2023
@Eric-Arellano Eric-Arellano self-assigned this Oct 2, 2023
@Eric-Arellano Eric-Arellano mentioned this issue Oct 2, 2023
Merged
Eric-Arellano added a commit that referenced this issue Oct 3, 2023
@Eric-Arellano
Revert to old version of API docs (#68)
f542c76 
There were a couple of regressions in the API generation script since we
last ran it in closed source. Those will be fixed in follow up PRs. See
#67.

This PR was created by simply copying and pasting the `api/` folders
from closed source. They are generated files, so we don't have to worry
about attribution.
@Eric-Arellano Eric-Arellano modified the milestones: Infra MVP fast-follow, mid-oct release Oct 5, 2023
@Eric-Arellano Eric-Arellano mentioned this issue Oct 19, 2023
Merged
Eric-Arellano added a commit that referenced this issue Oct 20, 2023
@Eric-Arellano
Fix permalinks with API generation for Sphinx 7.2+ (#212)
510e5a9 
Fixes one of the issues in
#67, that we weren't
removing the permalink in headers with qiskit-ibm-runtime:

![screenshot_2023-10-20_at_11 17
25___am_720](https://github.com/Qiskit/documentation/assets/14852634/4fde70dc-e8c5-424f-9d34-c71cba68501a)

This change is because of
sphinx-doc/sphinx@7e9a206.
Sphinx 7.2 changed the title from "Permalink" to "Link".
@Eric-Arellano Eric-Arellano mentioned this issue Oct 20, 2023
Merged
Eric-Arellano added a commit that referenced this issue Oct 20, 2023
@Eric-Arellano
Fix detection of module metadata with API generation (#221)
00d462f 
In Qiskit docs, which use an older version of Sphinx, the module ID is
set with HTML like this:

```html
<span class="target" id="module-qiskit.circuit">
               <span id="qiskit-circuit"></span>
             </span>
```

But in Runtime with Sphinx 7.2, it is set like this, without the
`.target` class:

```html
<span id="module-qiskit_ibm_runtime.options"></span>
```

So, we were failing to set metadata for modules, which caused those
files to not have "front matter" (Markdown metadata) and to not show up
in the TOC. See #67.

Note that we still look at `section` to determine the module metadata,
too. There continue to be some pages in IBM Provider that set their
module metadata that way.
This was referenced Oct 20, 2023
Closed
Merged
@Eric-Arellano
Copy link
Collaborator Author

The show stopper issues were fixed. I opened #224 for a small follow up.

Eric-Arellano added a commit that referenced this issue Oct 24, 2023
@Eric-Arellano
Update Runtime API docs to 0.13 (#222)
d666b50 
Now that we fixed #67, we
can regenerate the API docs. The issues were due to changes with modern
Sphinx 7.2.

There was one regression I noticed, but it's not enough of a
show-stopper to block this PR:
#224.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Revert to old version of API docs (Qiskit#68)
9fb536c 
There were a couple of regressions in the API generation script since we
last ran it in closed source. Those will be fixed in follow up PRs. See
Qiskit#67.

This PR was created by simply copying and pasting the `api/` folders
from closed source. They are generated files, so we don't have to worry
about attribution.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Fix permalinks with API generation for Sphinx 7.2+ (Qiskit#212)
5e70749 
Fixes one of the issues in
Qiskit#67, that we weren't
removing the permalink in headers with qiskit-ibm-runtime:

![screenshot_2023-10-20_at_11 17
25___am_720](https://github.com/Qiskit/documentation/assets/14852634/4fde70dc-e8c5-424f-9d34-c71cba68501a)

This change is because of
sphinx-doc/sphinx@7e9a206.
Sphinx 7.2 changed the title from "Permalink" to "Link".
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Fix detection of module metadata with API generation (Qiskit#221)
d68d12b 
In Qiskit docs, which use an older version of Sphinx, the module ID is
set with HTML like this:

```html
<span class="target" id="module-qiskit.circuit">
               <span id="qiskit-circuit"></span>
             </span>
```

But in Runtime with Sphinx 7.2, it is set like this, without the
`.target` class:

```html
<span id="module-qiskit_ibm_runtime.options"></span>
```

So, we were failing to set metadata for modules, which caused those
files to not have "front matter" (Markdown metadata) and to not show up
in the TOC. See Qiskit#67.

Note that we still look at `section` to determine the module metadata,
too. There continue to be some pages in IBM Provider that set their
module metadata that way.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Update Runtime API docs to 0.13 (Qiskit#222)
2fdcc70 
Now that we fixed Qiskit#67, we
can regenerate the API docs. The issues were due to changes with modern
Sphinx 7.2.

There was one regression I noticed, but it's not enough of a
show-stopper to block this PR:
Qiskit#224.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Eric-Arellano Eric-Arellano

Labels
infra 🏗️
Projects
Docs Planning
Archived in project
Milestone
mid-oct release
Development

Successfully merging a pull request may close this issue.

Update Runtime API docs to 0.13 Qiskit/documentation
1 participant
@Eric-Arellano