Quick Start


The fastest way to get started is by using the command line tool

$ sudo apt-get install python3-pip
$ sudo 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

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 python3-dev

On Windows, please install PyYAML using the binaries they provide

Run a sample demo

$ 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