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.

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

Corrections to docs for intersphinx #311

Merged
merged 13 commits into from
Jul 11, 2023
Merged

Conversation

SaashaJoshi
Copy link
Contributor

@SaashaJoshi SaashaJoshi commented Jul 6, 2023

Things corrected in this PR:

Things to look into:

- [ ] Interlink modules and attributes.

  • Reference to non-existing EntanglementForgingVQE class in entanglement_forging_operator (line 27).

https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/c5207b191b601223e8e4e5eb56b2200c256101e7/circuit_knitting/forging/entanglement_forging_operator.py#L22-L28

Related to:
Resolves #215

@coveralls
Copy link

coveralls commented Jul 6, 2023

Pull Request Test Coverage Report for Build 5521456168

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 90.703%

Totals Coverage Status
Change from base Build 5520136589: 0.0%
Covered Lines: 2556
Relevant Lines: 2818

💛 - Coveralls

@SaashaJoshi SaashaJoshi requested a review from garrison July 6, 2023 19:28
@garrison
Copy link
Member

garrison commented Jul 6, 2023

Does doing this alone allow any links to work that did not work before? I am curious. (We might have to prefix each identifier once with :external for it to be picked up.)

@SaashaJoshi
Copy link
Contributor Author

SaashaJoshi commented Jul 7, 2023

Does doing this alone allow any links to work that did not work before? I am curious. (We might have to prefix each identifier once with :external for it to be picked up.)

I realized we do not need :external anywhere. The interlinking works without it as well (I will make this change in the next commit).
However, I see that the internal classes like :class: TwoQubitQPDGate do not get linked; I am still figuring out this one.

@garrison
Copy link
Member

garrison commented Jul 7, 2023

However, I see that the internal classes like :class: TwoQubitQPDGate do not get linked; I am still figuring out this one.

It might be enough to say :class:`.TwoQubitQPDGate`, i.e., to prepend it with a dot each time it is mentioned.

@SaashaJoshi SaashaJoshi changed the title Add documentation links to qiskit-nature and qiskit-ibm-runtime for intersphinx Corrections to docs for intersphinx Jul 7, 2023
@garrison
Copy link
Member

garrison commented Jul 11, 2023

Related to:
#215

I think this may actually close #215. Is there anything left to do after the current PR?

EDIT: wait, I see: you've already adjusted this in the bulleted list. Nevermind! 🙂

@SaashaJoshi
Copy link
Contributor Author

I also made edit for #216 . I realized that issue was also covered in this PR.

Copy link
Member

@garrison garrison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks -- this looks great!

@SaashaJoshi SaashaJoshi merged commit a375dcb into Qiskit:main Jul 11, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants