Metadata-Version: 1.1
Name: ApiDoc
Version: 1.1a1
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.
        
        .. image:: https://raw.github.com/SolutionsCloud/apidoc/master/docs/source/_static/screenshot_sample.png
        
        It's developed by `Jérémy Derussé <http://github.com/jeremy-derusse>`_ and `SFR Business Team <http://www.sfrbusinessteam.fr>`_.
        
        `Full documentation available on ReadTheDocs. <http://apidoc.rtfd.org>`_
        
        `Demo available on http://solutionscloud.github.io/apidoc/demo <http://solutionscloud.github.io/apidoc/demo>`_
        
        
        
        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
        
        
        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:
        
        
        .. code-block:: console
        
            $ brew install libyaml
        
        On Linux, use your favorite package manager to install LibYAML. Here's how you do it on Debian/Ubuntu:
        
        
        .. code-block:: console
        
            $ sudo apt-get install libyaml-dev
        
        On Windows, please install PyYAML using the binaries they provide
        
        
        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-08-07)
        ----------------
        
        * Reduce resources size feature `Issue #6 <https://github.com/SolutionsCloud/apidoc/issues/6>`_
        * DiffMode on small devices feature `Issue #8 <https://github.com/SolutionsCloud/apidoc/issues/8>`_
        * Link to the top feature `Issue #9 <https://github.com/SolutionsCloud/apidoc/issues/9>`_
        * The keyword optional override code bug `Issue #10 <https://github.com/SolutionsCloud/apidoc/issues/10>`_
        * Inprove detected types feature `Issue #11 <https://github.com/SolutionsCloud/apidoc/issues/11>`_
        * Add rules on properties feature `Issue #12 <https://github.com/SolutionsCloud/apidoc/issues/12>`_
        * Add PATCH and OPTION method feature `Issue #13 <https://github.com/SolutionsCloud/apidoc/issues/13>`_
        * Replace shortcup popin by bootstrap modal `Issue #14 <https://github.com/SolutionsCloud/apidoc/issues/14>`_
        
        1.0 (2013-07-23)
        ----------------
        
        * Initial release
Platform: Any
Classifier: Development Status :: 3 - Alpha
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: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
