ApiDoc’s documentation

Summary

ApiDoc is a documentation generator designe for API built with Python and given by SFR Business Team.

ApiDoc consists of a command line interface. It is maintained in a single repository. By using this application you automatically require all of the necessary modules dependencies which are:

• 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+

Requirements

For core application

• PyYAML
• Jinja2
• JsonSchema

For developers who want to contribute code to ApiDoc

• behave
• coverage
• mock
• nose
• yuicompressor
• Sphinx

Contents

• Quick Start
  • Installation
  • Run a sample demo
• Usage of ApiDoc
  • Main commands
  • Generics Arguments
• Config’s File Format
  • Usage
  • Sample
  • input
  • filter
  • output
• Source’s File Format
  • configuration
  • versions
  • categories
  • methods
  • types
  • references
  • Objects
  • Customizations
  • Extends
• Contributing
  • Types of Contributions
  • Setting Up the Code for Local Development
  • Pull Request Guidelines
  • Tips

Licenses

ApiDoc uses the following projects:

Twitter Bootstrap

Jquery

MouseTrap

Icon Minia

Entypo

IcoMoon