flockdoc 0.0.4 (beta)

Create example API documentation in multiple languages

Usage

### Directory

You need (roughly) this directory structure.

├── code │   ├── test.py │   └── test.rb ├── docs │   └── index.md └── layout │ └── index.html ├── static

System Message: ERROR/3 (<string>, line 24)

Unexpected indentation.

├── styles.css └── some_img.jpg

It will be transformed into (roughly) this directory structure:

├── code │   ├── test.py.html │   └── test.rb.html ├── index.html └── static

System Message: ERROR/3 (<string>, line 34)

Unexpected indentation.

├── some_img.jpg └── styles.css

### Individual Files

For code, just write code as normal. Flockdoc will try to take care of formatting for you. The output will look a little like [Docco][docco].

For markdown, think [Jekyll][jekyll]: header with layout specified, and then your code. YAML header with Markdown body. Example:

title: Test context:

System Message: ERROR/3 (<string>, line 47)

Unexpected indentation.

key: value

System Message: WARNING/2 (<string>, line 48)

Block quote ends without a blank line; unexpected unindent.

--- This is a test document with a key: {{ key }}

Documents are passed through Jinja2 rendering before they are output.

[docco]: http://jashkenas.github.io/docco/ [jekyll]: http://jekyllrb.com/