brian-team / brian2cookbook Goto Github PK

I just created a couple of directories, tools and models, and put one thing in each to give an idea of the sort of thing that we want to do with the cookbook.

I was thinking, for models we should generate documentation simlarly to how we do it in Brian, using the docstring of the file. However, we could be smart about it and add plots, format equations with LaTeX, etc.

For tools, people should write their own documentation, but at least we could generate a list of tools with maybe some way of specifying a short description, etc.