Skip to main content

Api Documentation Generator

Project description

ApiDoc

https://travis-ci.org/SolutionsCloud/apidoc.png?branch=master https://coveralls.io/repos/SolutionsCloud/apidoc/badge.png https://pypip.in/v/ApiDoc/badge.png https://pypip.in/d/ApiDoc/badge.png https://requires.io/github/SolutionsCloud/apidoc/requirements.png?branch=develop

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)

1.0 (2013-07-23)

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ApiDoc, version 1.4.0
Filename, size File type Python version Upload date Hashes
Filename, size ApiDoc-1.4.0.tar.gz (285.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page