Skip to content

plotdevice/plotdevice-manual

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PlotDevice Manual

This repository contains the unassembled parts that make up the doc subdirectory of the plotdevice module (plus a script to glue them together).

To build the manual, set up a virtualenv and install the dependencies, then run build.py. It will chug through the source files and generate a file:// url-friendly hierarchy of pages in the doc subdirectory:

$ virtualenv env
$ source ./env/bin/activate
(env)$ pip install -r requirements.txt # uses jinja, pygments, bs4, & html5lib
(env)$ python build.py                 # build the manual
(env)$ open doc/manual.html            # view the table of contents