Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

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

README.rst

README

Overview

nw2rst is a small tool to allow people write Literate Programming using the reStructuredText language.

It is a noweb backend that processes noweb files and produces output in reStructuredText format. So the output can later be processed with tools like docutils to produce HTML, ODT, LaTeX and other formats.

Usage

In this directory, type make. This might work for most versions of make, from different operating systems. It will produce two files:

nw2rst.rst
The document generated that explains how nw2rst.sh works.
nw2rst.sh
The nw2rst program. It is a simple shell script that should in any Unix enviornment.

Take a look at the nw2rst.nw file to see an example of a document written in reStructuredText for noweb processing.

To generate the reStructuredText file from a noweb file, use the option -backend of the noweave tool:

noweave -backend nw2rst.sh input.nw > output.rst

Contact and bug report

If you have any suggestions, bug report, etc., just open an issue in http://github.com/silasdb/nw2rst.

You might want to visit my personal page at silas.net.br where you'll find contact information.

About

A noweb backend to allow literate programming with reStructuredText

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.