danchr / apidoc

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