Family packages in main documentation#2616
Conversation
Ericgig
left a comment
There was a problem hiding this comment.
Could you fix the conflict and the failing documentation build.
Documentation must build without warnings. Removing guide-control left some references not used.
pmenczel
left a comment
There was a problem hiding this comment.
Thank you for working on this issue. It looks mostly good to me, other than the technical issue mentioned by Eric.
To make a nested list in RST, you need to include a blank line before the beginning of the nested list, as in
- This is a list item.
* This is nested item 1.
* This is nested item 2.
Pinging @BoxiLi and @flowerthrower who are responsible for QIP and QOC so they can get the chance to have a look at the text.
|
Thanks for the feedback I'll fix the nested list formatting in rst and documentation build conflict in doc/guide/guide-control.rst and make sure everything is good to go. Let me know if there’s anything else that needs attention! |
|
There is still a merge conflict since |
|
Thank you. I have removed one more unused reference. |
Checklist
You can use pycodestyle to check your code automatically
docfolder, and the notebook. Feel free to ask if you are not sure.doc/changes/<PR number>.<type>'type' can be one of the following: feature, bugfix, doc, removal, misc, or deprecation (see here for more information).Description
Removes the content of the "Quantum Optimal Control" page in the Users Guide and add "Family guide" page in Users guide which give description about the family packages of Qutip with their links
Related issues or PRs
fixes #2524