Api Documentation Generator
Project description
ApiDoc
Summary
ApiDoc is a documentation generator designe for API built with Python.
It’s developed by Jérémy Derussé and SFR Business Team.
Full documentation available on ReadTheDocs.
Demo available on http://solutionscloud.github.io/apidoc/demo
Installation
The fastest way to get started is by using the command line tool
$ sudo apt-get install python3-pip
$ pip3 install apidoc
The config parser script depends on PyYAML which links with LibYAML, which brings a performance boost to the PyYAML parser. However, installing LibYAML is optional but recommended. On Mac OS X, you can use homebrew to install LibYAML:
$ brew install libyaml
On Linux, use your favorite package manager to install LibYAML. Here’s how you do it on Debian/Ubuntu:
$ sudo apt-get install libyaml-dev
On Windows, please install PyYAML using the binaries they provide
Try it
You can download a sample file and try to render it documentation
$ mkdir apidoc
$ cd apidoc
$ wget https://raw.github.com/SolutionsCloud/apidoc/master/example/demo/source.yml
$ apidoc-render -f source.yml -o output/index.html
$ firefox output/index.html
Changelog
1.1 (2013-08-07)
Reduce resources size feature Issue #6
DiffMode on small devices feature Issue #8
Link to the top feature Issue #9
The keyword optional override code bug Issue #10
Inprove detected types feature Issue #11
Add rules on properties feature Issue #12
Add PATCH and OPTION method feature Issue #13
Replace shortcup popin by bootstrap modal Issue #14
1.0 (2013-07-23)
Initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.