Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  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.


Project details

Download files

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

Files for flockdoc, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size flockdoc-0.0.4.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page