search

fiuneuro / brainconn

A Python implementation of the brain connectivity toolbox. **Not actively maintained.**
https://brainconn.readthedocs.io
GNU General Public License v3.0
30 stars 21 forks source link

Add examples #24

Closed tsalo closed 2 years ago

tsalo commented 6 years ago

We currently have the RTD site set up with sphinx_gallery, which runs examples saved in Python scripts like this one and renders them similarly to Jupyter notebooks on the site. People can download these examples either as scripts (i.e., text files) or as notebooks. What's really cool is that figures from the examples are rendered in the example gallery, but the examples need to have figures to make it worth it. If our examples don't include figures (and thus don't need to be run on the site), we can go with the user guide approach instead (here's an example), wherein we walk potential users through the different submodules (with code snippets) and describe their functionality.

We should figure out whether we want a gallery or a user guide, which is going to be primarily determined based on whether our examples will include figures or not, and then we need to actually write those examples.

tsalo commented 6 years ago

I started adding these in #27. The ones I'm adding now can act as templates for others at the hackathon.