Skip to content

ellbur/rstweaver

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

rstweaver

rstweaver is a set of reST directives aimed at producing an effect similar to Sweave.

rstweaver differs from Sweave in one significant way: in order to get an effect similar to "interactive" sessions for manifestly non-interactive languages (my particular motivation was Haskell), rstweaver supports incremental building, modifying and executing of multiple named files.

Dependencies

  1. treewatcher - treewatcher also uses pyinotify which uses the inotify Linux system call, so it will only run on Linux.
  2. *my* docutils - because I fixed some bugs and added some features that rstweaver uses. This was a questionable decision. For my thoughts on it see Welcome to my github world.
  3. pygments

Installation

sudo python setup.py install

Contents

This distribution contains two things:

  1. A library for writing reST directives to support literate programming.
  2. A terribly minimal program rstweave for converting reST documents to HTML using these directives.

Documentation

http://ellbur.github.com/rstweaver/

Supported Languages

Currently:

  • Haskell
  • C++
  • Python
  • reST

But adding languages is easy.

Hacking

The code is an utter mess. The parts necessary to write new directives should be decently documented. I welcome any changes -- you can't possibly make it worse.

License

Whatevs.

Todo

  • Plots

About

reST directives for literate programming

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages