{ "info": { "author": "J\u00e9r\u00e9my Deruss\u00e9", "author_email": "jeremy.derusse@sfr.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Natural Language :: English", "Operating System :: MacOS", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "ApiDoc\n======\n\n.. image:: https://travis-ci.org/SolutionsCloud/apidoc.png?branch=master\n :target: https://travis-ci.org/SolutionsCloud/apidoc\n.. image:: https://coveralls.io/repos/SolutionsCloud/apidoc/badge.png\n :target: https://coveralls.io/r/SolutionsCloud/apidoc\n.. image:: https://pypip.in/v/ApiDoc/badge.png\n :target: https://preview-pypi.python.org/project/ApiDoc\n.. image:: https://pypip.in/d/ApiDoc/badge.png\n :target: https://preview-pypi.python.org/project/ApiDoc\n.. image:: https://requires.io/github/SolutionsCloud/apidoc/requirements.png?branch=develop\n :target: https://requires.io/github/SolutionsCloud/apidoc/requirements/?branch=develop\n\nSummary\n-------\n\n`ApiDoc `_ is a documentation generator designed for API built with Python and given by `SFR Business Team `_.\n\n.. image:: https://raw.github.com/SolutionsCloud/apidoc/master/docs/source/_static/screenshot_sample.png\n\n* Demo: http://solutionscloud.github.io/apidoc/demo\n* Home Page: http://solutionscloud.github.io/apidoc\n* Documentation: http://apidoc.rtfd.org\n* Bug Tracker: https://github.com/SolutionsCloud/apidoc/issues\n* GitHub: https://github.com/SolutionsCloud/apidoc\n* PyPI: https://preview-pypi.python.org/project/ApiDoc\n* License: GPLv3+\n\n\nInstallation\n------------\n\nThe fastest way to get started is by using the command line tool\n\n.. code-block:: console\n\n $ sudo apt-get install python3-pip\n $ pip3 install apidoc\n\nIf the package python3-pip does not exists\n\n.. code-block:: console\n\n $ sudo apt-get install python3-setuptools\n $ sudo easy_install3 pip\n $ sudo pip3-2 install apidoc\n\n\nTry it\n------\n\nYou can download a sample file and try to render it documentation\n\n.. code-block:: console\n\n $ mkdir apidoc\n $ cd apidoc\n $ wget https://raw.github.com/SolutionsCloud/apidoc/master/example/demo/source.yml\n $ apidoc -i source.yml -o output/index.html\n $ firefox output/index.html\n\n\nChangelog\n=========\n\n1.3 (2016-05-08)\n----------------\n\n* Small fixes\n\n1.2 (2014-01-22)\n----------------\n\n* `Feature #17 `_ Merge ApiDoc's binaries\n* `Feature #18 `_ Merge cli arguments -f and -d in one argument -i (input)\n* `Feature #21 `_ Add patternProperties and additionalProperties in objects\n* `Feature #22 `_ \"properties\" and \"items\" are optionals\n* `Feature #23 `_ The property \"type\" is optional\n* `Bug #26 `_ Searchbox hide wrongly some elements\n* `Bug #27 `_ Keyboard shortcut for diff on search's filtered items\n* `Feature #32 `_ Enhances the theme of the readthedocs\n\n1.1 (2013-08-28)\n----------------\n\n* `Feature #6 `_ Reduce resources size\n* `Feature #8 `_ DiffMode on small devices\n* `Feature #9 `_ Link to the top\n* `Bug #10 `_ The keyword optional override cod\n* `Feature #11 `_ Inprove detected types\n* `Feature #12 `_ Add rules on properties\n* `Feature #13 `_ Add PATCH and OPTION method\n* `Feature #14 `_ Replace shortcup popin by bootstrap modal\n* `Feature #16 `_ Upgrade to Bootstrap 3\n* `Bug #19 `_ Add constraints in sampled objects\n* `Bug #31 `_ Error \"TemplateNotFound: default.html\" in version 1.1\n\n1.0 (2013-07-23)\n----------------\n\n* Initial release", "description_content_type": null, "docs_url": "https://pythonhosted.org/ApiDoc/", "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://solutionscloud.github.io/apidoc/", "keywords": null, "license": "GPLv3+", "maintainer": null, "maintainer_email": null, "name": "ApiDoc", "package_url": "https://pypi.org/project/ApiDoc/", "platform": "Any", "project_url": "https://pypi.org/project/ApiDoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://solutionscloud.github.io/apidoc/" }, "release_url": "https://pypi.org/project/ApiDoc/1.4.0/", "requires_dist": null, "requires_python": null, "summary": "Api Documentation Generator", "version": "1.4.0" }, "last_serial": 2104577, "releases": { "1.0": [], "1.1": [ { "comment_text": "", "digests": { "md5": "26a5ccb201baf812a931a16e25223bb6", "sha256": "8c925736cd0363a141af7d3b2530ea8a364db0b236f17586256219649e78addf" }, "downloads": -1, "filename": "ApiDoc-1.1.tar.gz", "has_sig": false, "md5_digest": "26a5ccb201baf812a931a16e25223bb6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 283848, "upload_time": "2013-11-12T10:18:04", "url": "https://files.pythonhosted.org/packages/0e/78/7f8d65b49eb99964ac236495e94b6ce6eb1f937de65a88ebd67af923ed4d/ApiDoc-1.1.tar.gz" } ], "1.1a0": [ { "comment_text": "", "digests": { "md5": "9948046284131bb0583758738d4fc466", "sha256": "ba6f9108d3335d3230f8e32e476dd4acc78515132846af86f83fa5c7a28d8dd0" }, "downloads": -1, "filename": "ApiDoc-1.1a0.tar.gz", "has_sig": false, "md5_digest": "9948046284131bb0583758738d4fc466", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 364045, "upload_time": "2013-08-07T18:46:57", "url": "https://files.pythonhosted.org/packages/0c/b7/960942a51ba20ab904244a826f54de416990b80db260264266feadfc92dc/ApiDoc-1.1a0.tar.gz" } ], "1.1a1": [ { "comment_text": "", "digests": { "md5": "05dcc153a08327d6f2b299d69a1db013", "sha256": "b8f7748ec6c85729698db69c473435ff0010d0fdfdeebc9fb2860ea835893ae6" }, "downloads": -1, "filename": "ApiDoc-1.1a1.tar.gz", "has_sig": false, "md5_digest": "05dcc153a08327d6f2b299d69a1db013", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 286996, "upload_time": "2013-08-07T20:44:05", "url": "https://files.pythonhosted.org/packages/69/27/64840890fa49b9a0a7e3441995ad9e4809e201e28c892048af5871d01e71/ApiDoc-1.1a1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "159755de604634ed1772ca5dfdf820b5", "sha256": "7798d27220f2426c4609d0d22b312ef30fddd1ff8deee564c7bce8054f9cfbde" }, "downloads": -1, "filename": "ApiDoc-1.2.tar.gz", "has_sig": false, "md5_digest": "159755de604634ed1772ca5dfdf820b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 284900, "upload_time": "2014-01-22T20:59:09", "url": "https://files.pythonhosted.org/packages/c0/a3/44314b60f94a0cd851b0c75763015f67c9cf76d012c4551f2dd095f03a8b/ApiDoc-1.2.tar.gz" } ], "1.4": [], "1.4.0": [ { "comment_text": "", "digests": { "md5": "bba5ed9334364e7925d42de41e46c1c2", "sha256": "22a5af3621b96b4295c9d485bc6a071ca4101e4d5fd58e71af59d309f0f9bfd1" }, "downloads": -1, "filename": "ApiDoc-1.4.0.tar.gz", "has_sig": false, "md5_digest": "bba5ed9334364e7925d42de41e46c1c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 285324, "upload_time": "2016-05-07T23:06:51", "url": "https://files.pythonhosted.org/packages/57/76/8881ccd63949eb4cab2df10ceb33c4e2793dfbeebcd9f10fe634ba37225e/ApiDoc-1.4.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "bba5ed9334364e7925d42de41e46c1c2", "sha256": "22a5af3621b96b4295c9d485bc6a071ca4101e4d5fd58e71af59d309f0f9bfd1" }, "downloads": -1, "filename": "ApiDoc-1.4.0.tar.gz", "has_sig": false, "md5_digest": "bba5ed9334364e7925d42de41e46c1c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 285324, "upload_time": "2016-05-07T23:06:51", "url": "https://files.pythonhosted.org/packages/57/76/8881ccd63949eb4cab2df10ceb33c4e2793dfbeebcd9f10fe634ba37225e/ApiDoc-1.4.0.tar.gz" } ] }