API generation script: fix attributes headings #1153
Conversation
|
Thanks for contributing to Qiskit documentation! 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. Thanks! 🙌 |
frankharkins
left a comment
frankharkins
left a comment
There was a problem hiding this comment.
Thanks! This is a net improvement but I noticed a couple of quirks
Eric-Arellano
left a comment
Eric-Arellano
left a comment
There was a problem hiding this comment.
Thanks! Can you please clarify in the PR that you regenerated the HTML to fix the bad attribute? This PR is a mix of using the new HTML + your new code change
| </Class> | ||
|
|
||
| ### QPY\_VERSION | ||
| ### qiskit.qpy.QPY\_VERSION |
There was a problem hiding this comment.
Do you know what these were before the docs redesign? I'm not certain it makes sense to use the full path here because it makes the header longer. I'm surprised the name is the full path and not only QPY_VERSION. It's not necessarily bad, I'm only curious why name was set to that
There was a problem hiding this comment.
Yes, they had the long name as well. Here is the file before the docs redesign. I can investigate more about why it was set that way if you want :)
Closes Qiskit#1120 This PR changes the script to use the `name` extracted from the `signature` of the attributes instead of using the `id` to create the `<h3>`s. This behavior was changed in Qiskit#1026, but It broke a couple of headings. It also fixes two attributes of `qiskit.algorithms.eigensolvers.VQD` manually modifying the artifacts stored in [Box](https://ibm.ent.box.com/folder/246867452622?s=tqmvw6ldivzkhh934nhufan4rg3dregr) for versions 0.39, 0.40, 0.41, 0.42, 0.43, 0.44, 0.45 and 0.46. See more at Qiskit#1120
4 participants
Closes #1120
This PR changes the script to use the
nameextracted from thesignatureof the attributes instead of using theidto create the<h3>s. This behavior was changed in #1026, but It broke a couple of headings.It also fixes two attributes of
qiskit.algorithms.eigensolvers.VQDmanually modifying the artifacts stored in Box for versions 0.39, 0.40, 0.41, 0.42, 0.43, 0.44, 0.45 and 0.46. See more at #1120