-
Notifications
You must be signed in to change notification settings - Fork 68
Documentation fixes and updates #36
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
Conversation
Pull Request Test Coverage Report for Build 5879479626
💛 - Coveralls |
I looked over it again and tweaked a few bits. I think for the present it's done so I removed the [WIP] and On Hold. I know #33 I added algorithms_globals to the main init that I changed here - I am thinking there should not be a conflict though (hopefully!) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this PR, I added a few suggestions that in my opinion help clarify some of the text.
Co-authored-by: Elena Peña Tapia <[email protected]>
Change text to trigger CLA check
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Steve Wood <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, I think it's ok not to include the link to the primitive docs, I am expecting the primitive docs to be substantially revamped anyway, so we would probably have to change it soon.
Though I made that long comment about how I had considered link(s) when I did the update I merged the suggestion with the link in it. So the link is there now - but as you say it can be changed later. I figured as long as the docs were overall in better shape, which was the main intent of the update here for me, improvements can always be done in the future. |
Quick update of content Add aer to requirements-dev.txt Add networkx to requirements-dev.txt Fix spelling Recover grover try pin sphinx Delete IQPE Apply review comments Use short urls Apply comments from code review Update tweedledum reqs Add thumbnails to metadata Add try-except Fix gradients tag Default thumbnail Update docs/tutorials/02_vqe_advanced_options.ipynb Co-authored-by: Steve Wood <[email protected]> Update docs/tutorials/02_vqe_advanced_options.ipynb Co-authored-by: Steve Wood <[email protected]> Update docs/tutorials/05_qaoa.ipynb Co-authored-by: Steve Wood <[email protected]> Update docs/tutorials/10_pvqd.ipynb Co-authored-by: Steve Wood <[email protected]> Apply suggestions Documentation fixes and updates (qiskit-community#36) Co-authored-by: Elena Peña Tapia <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Remove pin
Co-authored-by: Elena Peña Tapia <[email protected]> Co-authored-by: Julien Gacon <[email protected]>
Summary
Main change is to document the (minumum)eigensolvers on the main page along with all the other algorithms now the short forms import the new primitive based algorithms.
At the same time I tried to fixup the navigation index on the left by altering titles and making things consistent in terms of headings etc.
I also edited text where it seems outdated - e.g. it now states upfront about primitives rather than have it repeat everywhere (before there were quantum instance based algos intermixed with primitive based ones so it was needed at that point - with the former removed now from this repo it just looked like a lot of repetition though).
I also put the algorithm groups in alphabetic order, they were pretty much, but.... - time evolvers was where evolvers once was and out of order. Hence it looks like quite a bit more change than it really is.
Details and comments
I marked it [WIP] since I do not consider the fixes/changes quite finished yet. The changes so far can be checked out in the CI docs artifacts which are built. Update: WIP removed.
FYI: The makefile change I did in #33 to support make clean/clean_sphinx to work I did not replicate here - so far I have resorted to manually deleting stubs and build to ensure it builds clean locally.