-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Developer Documentation #1639
Conversation
I've added the script+css that can be used to generate diagrams. Preview on the Concepts>{index,recipe} pages: https://arbor-rtd-dev.readthedocs.io/en/latest/ Needs to be expanded to cover all Concepts pages that benefit from a visual representation of their context. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a really good start, thanks a lot. I have a few comments and suggestions.
Merge remote-tracking branch 'upstream/master' into doc/dev
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I've given the schematics a visual update (bit more compressed), made them foldable inplaces and moved them to more appropriate places.
internals
merged intodev
. I've hidden the numerical methods page for now, as it did not really contain anything. That OK?- Update: I see now that this is a placeholder for
doc/math
, which has updates in this branch: https://github.com/halfflat/arbor/commits/doc/update-model I say we merge those changes in this PR, and link to the TeX for the time being.
- Update: I see now that this is a placeholder for
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only change I'd want to put in here (besides corrections): dev/numerics.rst
content and/or https://github.com/halfflat/arbor/tree/doc/update-model merged.
Possibly by using https://github.com/michael-brade/LaTeX.js
There is one last issue, I can't get RTD to generate the graphviz plots (which I'm certain I could a year ago or so). |
…phs on ecosystem page. Add some more NMODL dialect hints.
Introduction
To onboard new devs we need to able to get them up to speed quickly.
Here's my (rough) proposal
doc/internal
should be integrated into the developer part.I start in this PR by adding an introductionary guide to cable cells. It outlines the flow
of cable cell simulations through arbor, sketches how cable cell simulations are set up,
and has jumping off points to more in depth topics.
TODO
internal
)internal
)