Move example scripts to the docs website

[adamltyson]

And make sure the level of testing doesn't drop (the examples are run as part of the test).

[Adisauz]

where would I be able to find the website code so I can put a PR?

[adamltyson]

The relevant section is here: https://github.com/brainglobe/brainglobe.github.io/tree/main/docs/source/documentation/brainrender

[adamltyson]

Sphinx has some nice features for hosting examples. Might be worth looking into e.g. what we do with movement:

• Website: https://github.com/brainglobe/brainglobe.github.io/tree/main/docs/source/documentation/brainrender
• Source: https://github.com/neuroinformatics-unit/movement/tree/main/examples

[Adisauz]

Would it be better to include the example as a subtopic under brainrender, usage, or another section? 😊

[adamltyson]

probably brainrender/examples

[Adisauz]

I’ve compiled one example so far—could you confirm if this format works for you? Clicking on an example will display it, but I haven’t cracked the hover text yet (been wrestling with it for 3 hours now 😅). If this setup looks good, I’ll move forward with the rest. Let me know if you’d like any tweaks!

[Adisauz]

I think this video might help understand better :)
https://github.com/user-attachments/assets/cd33f23c-447d-4edd-92c3-381ae26c5295

[adamltyson]

Hi @Adisauz would you mind opening a pull request and we can discuss there? In the mean time, some suggestions:

• Could you remove the emojis? We don't use them anywhere else on the BrainGlobe website
• Could you remove the dependencies section? The examples should run once a user has installed brainrender.

[Adisauz]

Hey @adamltyson I have put up a PR brainglobe/brainglobe.github.io#314.