Skip to content

Family packages in main documentation#2616

Merged
pmenczel merged 5 commits into
qutip:masterfrom
kavya-r30:Kavya
Feb 16, 2025
Merged

Family packages in main documentation#2616
pmenczel merged 5 commits into
qutip:masterfrom
kavya-r30:Kavya

Conversation

@kavya-r30

@kavya-r30 kavya-r30 commented Jan 27, 2025

Copy link
Copy Markdown
Contributor

Checklist

  • Please read Contributing to QuTiP Development
  • Contributions to qutip should follow the pep8 style.
    You can use pycodestyle to check your code automatically
  • Please add tests to cover your changes if applicable.
  • If the behavior of the code has changed or new feature has been added, please also update the documentation in the doc folder, and the notebook. Feel free to ask if you are not sure.
  • Include the changelog in a file named: 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

screencapture-127-0-0-1-5500-qutip-doc-build-html-guide-guide-family-html-2025-01-27-21_07_49

Related issues or PRs
fixes #2524

@coveralls

coveralls commented Jan 29, 2025

Copy link
Copy Markdown

Coverage Status

coverage: 87.721% (-0.006%) from 87.727%
when pulling 60f0bcc on kavya-r30:Kavya
into 6dbd824 on qutip:master.

@Ericgig Ericgig left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you fix the conflict and the failing documentation build.
Documentation must build without warnings. Removing guide-control left some references not used.

@pmenczel pmenczel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@kavya-r30

Copy link
Copy Markdown
Contributor Author

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!

@pmenczel

Copy link
Copy Markdown
Member

There is still a merge conflict since guide-control was updated in the meantime. (It is fine to discard the changes there.)
Would you be able to resolve the conflict by merging the master branch into your branch?

@kavya-r30

Copy link
Copy Markdown
Contributor Author

@pmenczel @Ericgig
I'm very sorry for the delay in responding, I got caught up with other commitments.
I have merged the master branch into mine now

@pmenczel

Copy link
Copy Markdown
Member

Thank you. I have removed one more unused reference.

@pmenczel pmenczel merged commit 015a30b into qutip:master Feb 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Family packages in main documentation

4 participants