Home

Welcome to the pyNCS wiki!

Documentation

pyNCS Documentation can be found at <http://inincs.github.com/pyNCS>.

Here are the steps for updating the pyNCS documentation stored using github pages:

• pyNCS documentation is generated using Sphinx.
• The sphinx sources are in pyNCS/docs.
• Once the documentation is compiled, 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

Editing the wiki

We recommend the use of reStructuredText. Here is a nifty cheat-sheet for working with reStructuredText <http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt>