Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Api Documentation Generator

Project Description

ApiDoc

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
Release History

Release History

This version
History Node

1.4.0

History Node

1.4

History Node

1.2

History Node

1.1

History Node

1.1a1

History Node

1.1a0

History Node

1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
ApiDoc-1.4.0.tar.gz (285.3 kB) Copy SHA256 Checksum SHA256 Source May 7, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting