معرفی شرکت ها
ApiDoc-1.4.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Api Documentation Generator
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | ApiDoc-1.4.0 |
| نام | ApiDoc |
| نسخه کتابخانه | 1.4.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Jérémy Derussé |
| ایمیل نویسنده | jeremy.derusse@sfr.com |
| آدرس صفحه اصلی | http://solutionscloud.github.io/apidoc/ |
| آدرس اینترنتی | https://pypi.org/project/ApiDoc/ |
| مجوز | GPLv3+ |
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://preview-pypi.python.org/project/ApiDoc
.. image:: https://pypip.in/d/ApiDoc/badge.png
:target: https://preview-pypi.python.org/project/ApiDoc
.. image:: https://requires.io/github/SolutionsCloud/apidoc/requirements.png?branch=develop
:target: https://requires.io/github/SolutionsCloud/apidoc/requirements/?branch=develop
Summary
-------
`ApiDoc <http://solutionscloud.github.io/apidoc>`_ is a documentation generator designed 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://preview-pypi.python.org/project/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 -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 <https://github.com/SolutionsCloud/apidoc/issues/17>`_ Merge ApiDoc's binaries
* `Feature #18 <https://github.com/SolutionsCloud/apidoc/issues/18>`_ Merge cli arguments -f and -d in one argument -i (input)
* `Feature #21 <https://github.com/SolutionsCloud/apidoc/issues/21>`_ Add patternProperties and additionalProperties in objects
* `Feature #22 <https://github.com/SolutionsCloud/apidoc/issues/22>`_ "properties" and "items" are optionals
* `Feature #23 <https://github.com/SolutionsCloud/apidoc/issues/23>`_ The property "type" is optional
* `Bug #26 <https://github.com/SolutionsCloud/apidoc/issues/26>`_ Searchbox hide wrongly some elements
* `Bug #27 <https://github.com/SolutionsCloud/apidoc/issues/27>`_ Keyboard shortcut for diff on search's filtered items
* `Feature #32 <https://github.com/SolutionsCloud/apidoc/issues/32>`_ Enhances the theme of the readthedocs
1.1 (2013-08-28)
----------------
* `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
* `Bug #19 <https://github.com/SolutionsCloud/apidoc/issues/19>`_ Add constraints in sampled objects
* `Bug #31 <https://github.com/SolutionsCloud/apidoc/issues/31>`_ Error "TemplateNotFound: default.html" in version 1.1
1.0 (2013-07-23)
----------------
* Initial release
نحوه نصب
نصب پکیج whl ApiDoc-1.4.0:
pip install ApiDoc-1.4.0.whl
نصب پکیج tar.gz ApiDoc-1.4.0:
pip install ApiDoc-1.4.0.tar.gz