Fix detection of module metadata with API generation #221
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In Qiskit docs, which use an older version of Sphinx, the module ID is set with HTML like this:
But in Runtime with Sphinx 7.2, it is set like this, without the
.targetclass: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
sectionto determine the module metadata, too. There continue to be some pages in IBM Provider that set their module metadata that way.