Skip to content

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

Merged
merged 14 commits into from
Aug 17, 2023
Merged

Documentation fixes and updates #36

merged 14 commits into from
Aug 17, 2023

Conversation

woodsp-ibm
Copy link
Member

@woodsp-ibm woodsp-ibm commented Aug 4, 2023

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.

@woodsp-ibm woodsp-ibm added documentation Improvements or additions to documentation on hold Can not fix yet labels Aug 4, 2023
@coveralls
Copy link

coveralls commented Aug 4, 2023

Pull Request Test Coverage Report for Build 5879479626

  • 3 of 3 (100.0%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.947%

Totals Coverage Status
Change from base Build 5868912123: 0.0%
Covered Lines: 6451
Relevant Lines: 7172

💛 - Coveralls

@woodsp-ibm woodsp-ibm changed the title [WIP] Documentation fixes and updates Documentation fixes and updates Aug 8, 2023
@woodsp-ibm woodsp-ibm removed the on hold Can not fix yet label Aug 8, 2023
@woodsp-ibm
Copy link
Member Author

woodsp-ibm commented Aug 8, 2023

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!)

Copy link
Collaborator

@ElePT ElePT left a 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.

Change text to trigger CLA check
Copy link
Collaborator

@ElePT ElePT left a 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.

@mergify mergify bot merged commit 3570f7c into qiskit-community:main Aug 17, 2023
@woodsp-ibm
Copy link
Member Author

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.

@woodsp-ibm woodsp-ibm deleted the docs_update branch August 17, 2023 13:42
ElePT added a commit to ElePT/qiskit-algorithms that referenced this pull request Aug 21, 2023
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
ElePT added a commit to ElePT/qiskit-algorithms that referenced this pull request Aug 22, 2023
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants