ApiDoc 1.4.0

Api Documentation Generator

ApiDoc

Summary

ApiDoc is a documentation generator designed for API built with Python and given by SFR Business Team.

• Demo: http://solutionscloud.github.io/apidoc/demo

• Home Page: http://solutionscloud.github.io/apidoc

• Documentation: http://apidoc.rtfd.org

• Bug Tracker: https://github.com/SolutionsCloud/apidoc/issues

• GitHub: https://github.com/SolutionsCloud/apidoc

• PyPI: https://preview-pypi.python.org/project/ApiDoc

• 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 -i source.yml -o output/index.html
$ firefox output/index.html

Changelog

1.3 (2016-05-08)

• Small fixes

1.2 (2014-01-22)

• Feature #17 Merge ApiDoc’s binaries

• Feature #18 Merge cli arguments -f and -d in one argument -i (input)

• Feature #21 Add patternProperties and additionalProperties in objects

• Feature #22 “properties” and “items” are optionals

• Feature #23 The property “type” is optional

• Bug #26 Searchbox hide wrongly some elements

• Bug #27 Keyboard shortcut for diff on search’s filtered items

• Feature #32 Enhances the theme of the readthedocs

1.1 (2013-08-28)

• 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