Metadata-Version: 1.1
Name: ApiDoc
Version: 1.1
Summary: Api Documentation Generator
Home-page: http://solutionscloud.github.io/apidoc/
Author: Jérémy Derussé
Author-email: jeremy.derusse@sfr.com
License: GPLv3+
Description: ApiDoc
        ======
        
        .. image:: https://travis-ci.org/SolutionsCloud/apidoc.png?branch=master
                :target: https://travis-ci.org/SolutionsCloud/apidoc
        .. image:: https://coveralls.io/repos/SolutionsCloud/apidoc/badge.png
                :target: https://coveralls.io/r/SolutionsCloud/apidoc
        .. image:: https://pypip.in/v/ApiDoc/badge.png
                :target: https://crate.io/packages/ApiDoc
        .. image:: https://pypip.in/d/ApiDoc/badge.png
                :target: https://crate.io/packages/ApiDoc
        
        Summary
        -------
        
        `ApiDoc <http://solutionscloud.github.io/apidoc>`_ is a documentation generator designe for API built with Python and given by `SFR Business Team <http://www.sfrbusinessteam.fr>`_.
        
        .. image:: https://raw.github.com/SolutionsCloud/apidoc/master/docs/source/_static/screenshot_sample.png
        
        * 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://pypi.python.org/pypi/apidoc
        * License: GPLv3+
        
        
        Installation
        ------------
        
        The fastest way to get started is by using the command line tool
        
        .. code-block:: console
        
            $ sudo apt-get install python3-pip
            $ pip3 install apidoc
        
        If the package python3-pip does not exists
        
        .. code-block:: console
        
           $ 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
        
        .. code-block:: console
        
            $ mkdir apidoc
            $ cd apidoc
            $ wget https://raw.github.com/SolutionsCloud/apidoc/master/example/demo/source.yml
            $ apidoc-render -f source.yml -o output/index.html
            $ firefox output/index.html
        
        
        Changelog
        =========
        
        1.1 (2013-??-??)
        ----------------
        
        * `Feature #6 <https://github.com/SolutionsCloud/apidoc/issues/6>`_ Reduce resources size
        * `Feature #8 <https://github.com/SolutionsCloud/apidoc/issues/8>`_ DiffMode on small devices
        * `Feature #9 <https://github.com/SolutionsCloud/apidoc/issues/9>`_ Link to the top
        * `Bug #10 <https://github.com/SolutionsCloud/apidoc/issues/10>`_ The keyword optional override cod
        * `Feature #11 <https://github.com/SolutionsCloud/apidoc/issues/11>`_ Inprove detected types
        * `Feature #12 <https://github.com/SolutionsCloud/apidoc/issues/12>`_ Add rules on properties
        * `Feature #13 <https://github.com/SolutionsCloud/apidoc/issues/13>`_ Add PATCH and OPTION method
        * `Feature #14 <https://github.com/SolutionsCloud/apidoc/issues/14>`_ Replace shortcup popin by bootstrap modal
        * `Feature #16 <https://github.com/SolutionsCloud/apidoc/issues/16>`_ Upgrade to Bootstrap 3
        
        1.0 (2013-07-23)
        ----------------
        
        * Initial release
Platform: Any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
