Skip to content

Move example scripts to the docs website #354

Open

Description

@adamltyson

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

Activity

  1. Adisauz commented on Mar 19, 2025

    @Adisauz

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

  2. adamltyson commented on Mar 19, 2025

    @adamltyson
    MemberAuthor
  3. adamltyson commented on Mar 19, 2025

    @adamltyson
    MemberAuthor

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

  4. Adisauz commented on Mar 19, 2025

    @Adisauz

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

  5. adamltyson commented on Mar 20, 2025

    @adamltyson
    MemberAuthor

    probably brainrender/examples

  6. Adisauz commented on Mar 20, 2025

    @Adisauz

    Image

    Image
    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!

  7. Adisauz commented on Mar 20, 2025

    @Adisauz
  8. adamltyson commented on Mar 21, 2025

    @adamltyson
    MemberAuthor

    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.
  9. Adisauz commented on Mar 21, 2025

    @Adisauz
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions