QuTiP release 5.3.0

[veronikakurth]

No description provided.

[hodgestar]

I'm wondering what we should do about links to previous documentation. The list below has 5.1.1, so we could add 5.2.3, but it also seems strange to only link to qutip documentation and not the other packages.

Perhaps we should add 5.2.3 below, and then make a plan to sort out how documentation is linked to later. E.g. It would be nice to link to one RTD page and not have to update the links ourselves so often. Not sure RTDs has such a page though.

[veronikakurth]

Thank you for your feedback, Simon!

I added links to 5.2.3.

To the first point: I agree that ideally, all packages of the QuTiP family and their versioning info are listed in some systematic way. Currently, at the bottom of the home page, for example, we see links to other packages, but they are a bit inconsistent: one links to RTD of the latest stable version (QIP), another links to the repository on GitHub (QOC).

To the second point: I agree there should be a way to avoid touching the links upon every release (especially given that there is more than one package we develop!). I would have a look into that.

[veronikakurth]

P.S. I have to admit, I don't fully understand how and where this documentation.md page is rendered. On the website, I don't see information about previous releases, for example, only about the latest. @Langhaarzombie Max, could you give me a hint on where to look, please? :) I.e., how all this information from the markdown file comes into the right place, which part of the codebase gets is responsible for it.

[Langhaarzombie]

Thanks for checking out the mysteries of the website 🪄 Much of this is automatically done by Jekyll (which is the website builder that we are using). So, a Markdown file in the main directory will become a page just like that. This is the same for documentation.md, devs.md, features.md etc. Let me know if you want more details!

documentation.md is reachable via qutip.org/documentation or by going to Resources > All Versions in the nav bar. I kept it as part of the website because, first, I see it as a feature that I can download pdf files with all the documentation ready. And second, it has been indexed by Google. So googling qutip documentation will likely bring up that page as a top result.

So regarding the points:

• I agree, all packages should be indexed in one single page with all their versions (and perhaps corresp. documentation). Maybe the documentation page is the place for that? Though something that automatically updates would be nicer (i.e. GitHub).
• In case we do that, we can change the /documentation page to a redirect or similar. That is no problem!

[Langhaarzombie]

Thanks for checking out the mysteries of the website 🪄 Much of this is automatically done by Jekyll (which is the website builder that we are using). So, a Markdown file in the main directory will become a page just like that. This is the same for documentation.md, devs.md, features.md etc. Let me know if you want more details!

documentation.md is reachable via qutip.org/documentation or by going to Resources > All Versions in the nav bar. I kept it as part of the website because, first, I see it as a feature that I can download pdf files with all the documentation ready. And second, it has been indexed by Google. So googling qutip documentation will likely bring up that page as a top result.

So regarding the points:

• I agree, all packages should be indexed in one single page with all their versions (and perhaps corresp. documentation). Maybe the documentation page is the place for that? Though something that automatically updates would be nicer (i.e. GitHub).
• In case we do that, we can change the /documentation page to a redirect or similar. That is no problem!

[veronikakurth]

@Langhaarzombie Thank you very much for your feedback and explanations, Max!
@Ericgig, could you or Max please merge this PR on my behalf? Thank you!