Skip to content

snetdev/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SNet technical documentation

This repository contains documentation and small examples / unit tests for the SNet technology.

To view the documentation after formatting: http://readthedocs.org/docs/snetdev/

To generate the documentation on your own system:

  1. clone this repo.
  2. use make, eg. make html or make latexpdf.

We use:

  • to format the text, reStructuredText, a handy markup language for technical documentation. Version 0.9 or later of Python Docutils is required for code syntax coloring.
  • to bundle the individual files into one documentation, Sphinx, a handy documentation generator able to emit multiple formats (TeX, HTML, ePUB, info, manual pages) from reStructuredText.

Releases

No releases published

Packages

No packages published