Fix metadata detection of modules for historical Qiskit docs #821
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
|
I recommend viewing by commit. The first commit is the only manual one. I will spend the time this afternoon to closely review each commit - so feel free to do more of a spot check. |
arnaucasau
approved these changes
Feb 15, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
) Part of Qiskit#66. We were failing to detect modules using old versions of Sphinx that set the module metadata in `<div>` rather than `<span>` or `<section>`. Some of the module pages had no metadata at all, whereas some were misclassified as `functions` corresponding to the first function in the module's page. Fixing this metadata will fix the HTML meta properties, and it also fixes the table of contents to have correct nesting.
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.
Part of #66. We were failing to detect modules using old versions of Sphinx that set the module metadata in
<div>rather than<span>or<section>.Some of the module pages had no metadata at all, whereas some were misclassified as
functionscorresponding to the first function in the module's page. Fixing this metadata will fix the HTML meta properties, and it also fixes the table of contents to have correct nesting.