Api Documentation Generator
Project description
ApiDoc
Summary
ApiDoc is a documentation generator designe for API built with Python and given by SFR Business Team.
Home Page: http://solutionscloud.github.io/apidoc
Documentation: http://apidoc.rtfd.org
Bug Tracker: https://github.com/SolutionsCloud/apidoc/issues
License: GPLv3+
Installation
The fastest way to get started is by using the command line tool
$ sudo apt-get install python3-pip
$ pip3 install apidoc
If the package python3-pip does not exists
$ sudo apt-get install python3-setuptools
$ sudo easy_install3 pip
$ sudo pip3-2 install apidoc
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-??-??)
Feature #6 Reduce resources size
Feature #8 DiffMode on small devices
Feature #9 Link to the top
Bug #10 The keyword optional override cod
Feature #11 Inprove detected types
Feature #12 Add rules on properties
Feature #13 Add PATCH and OPTION method
Feature #14 Replace shortcup popin by bootstrap modal
Feature #16 Upgrade to Bootstrap 3
Bug #19 Add constraints in sampled objects
Bug #31 Error “TemplateNotFound: default.html” in version 1.1
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.