Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.


flockdoc is unavailable in PyPM, because there aren't any builds for it in the package repositories. Click the linked icons to find out why.

 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
Windows (64-bit)
Mac OS X (10.5+)
Linux (32-bit)
Linux (64-bit)

Create example API documentation in multiple languages (like [Stripe's API docs][stripe-api])

[stripe-api]: http://stripe.com/docs/api


### 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/

Subscribe to package updates

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.