Projects / pipadoc

pipadoc

Pipadoc extracts extracts special comments out of source files or plaintext files and let one define rules how to bring them into proper order. This is somewhat similar to Literate Programming, but it puts the emphasis back to the code, since the source is not extracted from a given "literate text", but the documentation is extracted from the source and then the structure of the generated documentation is defined by the programmer. Pipadoc is programming language and documentation system agnostic, all it requires is that the programming language has some kind of line or block comments in one can place doc statements. It provides a plugin system where one can extend functionality. Some plugins for asciidoc, index generation, and verbatim code sections are provided.

Tags
Licenses
Operating Systems
Implementation

Recent comments

02 Jun 2010 03:28 cehteh

There is no intention to make 'pipadoc' releases currently because it is so small. Improvements are contiguously added and it is in active use by some projects. Please refer to the latest commit in the git master.

Screenshot

Project Spotlight

OpenStack4j

A Fluent OpenStack client API for Java.

Screenshot

Project Spotlight

TurnKey TWiki Appliance

A TWiki appliance that is easy to use and lightweight.