API Link

[rcomer]

📚 Documentation

I was just looking at the new docs homepage and realised it’s not that obvious how to browse the various modules (“reference documentation” in the legacy docs). This is served by the “Iris API” link in the new docs, but that’s under “Developer Guide”. Should we have this linked somewhere more prominent?

[tkknight]

The link could move to User Guide or Reference section, which I think makes more sense.

In terms of making it more prominent, there is a sphinx extension named sphinx-panels that may be of use (I've not played with it yet). I've mentioned this extensions in an issue I just created #3883 capturing some thoughts after getting the docs to the state it is in now (a good one).

[tkknight]

I had a quick play with the panels extensions, see https://iris-test-doc.readthedocs.io/en/latest/ (this link will only show the content until this issue is closed)

[rcomer]

I like the examples under “More links....” Nice bold buttons for people who know what they’re looking for and a helpful description for those who don’t.

[tkknight]

I've iterated on this, see https://iris-test-doc.readthedocs.io/en/latest/#play-4

[tkknight]

The links shared to show the rendered html has now moved onto to show the PR I've created for this #3884.