GitHub - Code-Slave/bashdoc: The bashdoc script is a frontend which parse a bash file and create a documentation in specified format. This script works similar to javadoc for java projects, but use reStructuredText as middle language to provide the final document.

Code-Slave / bashdoc Public

forked from ajdiaz/bashdoc

Notifications You must be signed in to change notification settings
Fork 0
Star 0

The bashdoc script is a frontend which parse a bash file and create a documentation in specified format. This script works similar to javadoc for java projects, but use reStructuredText as middle language to provide the final document.

github.com/ajdiaz/bashdoc

0 stars 9 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 9 Commits
doc		doc
lib		lib
man		man
.todo		.todo
README		README
TODO		TODO
bashdoc		bashdoc

Repository files navigation

======
README
======

This script is a frontend for various awk(1) scripts which parse a bash
script (file) and create a documentation in specified format. This script
works similar to javadoc for java projects.

In library directory you can found an example of basic backend for
gawk.

Requirements
============
bashdoc is written in bash, and require almost bash >= 3.0,
gawk >= 3.1.5, docutils >= 0.4 and GNU coreutils.

Andrés J. Díaz <[email protected]>