Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Create example API documentation in multiple languages

Project Description


Create example API documentation in multiple languages (like [Stripe's API



### Directory

You need (roughly) this directory structure.

├── code
│   ├──
│   └── test.rb
├── docs
│   └──
└── layout
│ └── index.html
├── static
├── styles.css
└── some_img.jpg

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

├── code
│   ├──
│   └── test.rb.html
├── index.html
└── static
├── 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
key: value
This is a test document with a key: {{ key }}

Documents are passed through Jinja2 rendering before they are output.


Release History

This version
History Node


History Node


History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(4.9 kB) Copy SHA256 Hash SHA256
Source None Jun 25, 2013

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers