inincs / pyNCS

pyNCS is a python library that allows easy access to Neuromorphic Chips and Systems (NCS),
http://inincs.github.com/pyNCS/
GNU General Public License v2.0
16 stars 10 forks source link

Updating the wiki documentation #5

Closed eneftci closed 12 years ago

eneftci commented 12 years ago

Here are the steps for updating the pyNCS documentation:

The documentation is stored using github pages on http://inincs.github.com/pyNCS/

The sphinx sources are in pyNCS/docs. The build is copied to the gh-pages branch (this is the githubs recommendation)

To update the docs, assuming gh-pages is cloned to pyNCS-docs: cd pyNCS-docs rsync pyNCS/docs/_build/html/ ./ -uav git commit git push

sheiksadique commented 12 years ago

Shouldn't we use the wiki for this ? Github also provides wiki pages. It is disabled for now but if you think thats useful we could use that for general comments and instructions.

Althought it serves the same purpose as our documentation pages for now, wikis have the advantage that any github user can edit them. So that could be used as a forum too i suppose ?

giacomoi commented 12 years ago

I think the issue-list is more appropriate for the posts #2,3,4. But I agree that we could/should use the wiki for writing instructions or useful info like the one Emre posted on post #5....

Sadque: can you set the wiki up?

ciao, g.

On 25/08/12 12:19, sheiksadique wrote:

Shouldn't we use the wiki for this ? Github also provides wiki pages. It is disabled for now but if you think thats useful we could use that for general comments and instructions.

Althought it serves the same purpose as our documentation pages for now, wikis have the advantage that any github user can edit them. So that could be used as a forum too i suppose ?

— Reply to this email directly or view it on GitHub https://github.com/inincs/pyNCS/issues/5#issuecomment-8021992.

Giacomo Indiveri http://ncs.ethz.ch/ Neuromorphic Cognitive Systems Institute of Neuroinformatics University of Zurich and ETH Zurich Winterthurerstrasse 190, 8057 Zurich, Switzerland office: Y55 G84 tel: +41 44 6353024 fax: +41 44 6353025

sheiksadique commented 12 years ago

Okk so here is the wiki.

https://github.com/inincs/pyNCS/wiki

I copy/pasted the instructions from Emre there as a start. I suppose we can fill it up as things progress.

giacomoi commented 12 years ago

Thanks!

g.

On 28/08/12 00:46, sheiksadique wrote:

Okk so here is the wiki.

https://github.com/inincs/pyNCS/wiki

I copy/pasted the instructions from Emre there as a start. I suppose we can fill it up as things progress.

— Reply to this email directly or view it on GitHub https://github.com/inincs/pyNCS/issues/5#issuecomment-8073677.

Giacomo Indiveri http://ncs.ethz.ch/ Neuromorphic Cognitive Systems Institute of Neuroinformatics University of Zurich and ETH Zurich Winterthurerstrasse 190, 8057 Zurich, Switzerland office: Y55 G84 tel: +41 44 6353024 fax: +41 44 6353025

eneftci commented 12 years ago

Thanks for taking care of that.

On Mon, Aug 27, 2012 at 3:46 PM, sheiksadique notifications@github.comwrote:

Okk so here is the wiki.

https://github.com/inincs/pyNCS/wiki

I copy/pasted the instructions from Emre there as a start. I suppose we can fill it up as things progress.

— Reply to this email directly or view it on GitHubhttps://github.com/inincs/pyNCS/issues/5#issuecomment-8073677.

Emre Neftci, Phd. Web: http://www.ini.unizh.ch/~emre/