[Documentation]: add workflow to test that code in documentation runs

[stephprince]

What would you like changed or added to the documentation and why?

It would be helpful to add a workflow that tests that all the code in the documentation runs successfully.

I'm not sure the best way to do this - maybe using sphinx doctest?

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

• I agree to follow this project's Code of Conduct
• Have you ensured this change was not already requested?

[CodyCBakerPhD]

Doctest is what we use on NeuroConv - example: https://github.com/catalystneuro/neuroconv/blob/main/docs/conversion_examples_gallery/behavior/audio.rst?plain=1

PyNWB does a fancier notebook type approach with Python files - example: https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/gallery/domain/ophys.py

Which takes a lot more setup but might stylistically work better. Whichever you prefer