Welcome to griffin’s documentation!¶
Release v0.0.1.dev1 (What’s new?).
griffin is an Apache 2.0-licensed documentation generator written in Python
leveraging the RAMLfications library to create API docs from RAML.
If you’ve never heard of RAML, you’re missing out:
RESTful API Modeling Language (RAML) is a simple and succinct way of describing practically-RESTful APIs. It encourages reuse, enables discovery and pattern-sharing, and aims for merit-based emergence of best practices. The goal is to help our current API ecosystem by solving immediate problems and then encourage ever-better API patterns. RAML is built on broadly-used standards such as YAML and JSON and is a non-proprietary, vendor-neutral open spec.
About¶
griffin’s documentation lives at Read the Docs, the code on GitHub.
It’s tested on Python 2.6, 2.7, 3.3+, and PyPy. Both Linux and OS X are supported.