Fix docs build with Pygments 2.15#9948
Merged
mtreinish merged 1 commit intoQiskit:mainfrom Apr 11, 2023
Merged
Conversation
The problem was because the latest version of Pygments included a docstring in `Lexer.__init__` that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the `__init__` docstring for this object; we're only interested in documenting the existence of object itself.
jakelishman
added
type: qa
Collaborator
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 4669964516
💛 - Coveralls |
mtreinish
approved these changes
Apr 11, 2023
Member
mtreinish
left a comment
mtreinish
left a comment
There was a problem hiding this comment.
LGTM, thanks for fixing this so we can remove the version cap
mergify Bot
pushed a commit
that referenced
this pull request
Apr 11, 2023
The problem was because the latest version of Pygments included a docstring in `Lexer.__init__` that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the `__init__` docstring for this object; we're only interested in documenting the existence of object itself. (cherry picked from commit e598593)
jakelishman
added a commit
that referenced
this pull request
Apr 11, 2023
The problem was because the latest version of Pygments included a docstring in `Lexer.__init__` that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the `__init__` docstring for this object; we're only interested in documenting the existence of object itself. (cherry picked from commit e598593) Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
giacomoRanieri
pushed a commit
to giacomoRanieri/qiskit-terra
that referenced
this pull request
Apr 16, 2023
The problem was because the latest version of Pygments included a docstring in `Lexer.__init__` that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the `__init__` docstring for this object; we're only interested in documenting the existence of object itself.
king-p3nguin
pushed a commit
to king-p3nguin/qiskit-terra
that referenced
this pull request
May 22, 2023
The problem was because the latest version of Pygments included a docstring in `Lexer.__init__` that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the `__init__` docstring for this object; we're only interested in documenting the existence of object itself.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
The problem was because the latest version of Pygments included a docstring in
Lexer.__init__that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the__init__docstring for this object; we're only interested in documenting the existence of object itself.Details and comments
This is the proper fix for the problem that #9938 quick-fixed.