View on GitHub

Apidoc

Api Documentation Generator

Download this project as a .zip file Download this project as a tar.gz file

Summary

ApiDoc is a documentation generator designe for API built with Python and given by http://www.sfrbusinessteam.fr

Screenshot

Installation

$ sudo apt-get install python3-pip
$ pip3 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 -i source.yml -o output/index.html
$ firefox output/index.html

The output rendered is available on http://solutionscloud.github.io/apidoc/demo