{ "info": { "author": "Brian Hicks", "author_email": "brian@brianthicks.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License" ], "description": "Flockdoc\n========\n\nCreate example API documentation in multiple languages (like [Stripe's API\ndocs][stripe-api])\n\n[stripe-api]: http://stripe.com/docs/api \n\nUsage\n-----\n\n### Directory\n\nYou need (roughly) this directory structure.\n\n \u251c\u2500\u2500 code\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 test.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 test.rb\n \u251c\u2500\u2500 docs\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 index.md\n \u2514\u2500\u2500 layout\n \u2502 \u2514\u2500\u2500 index.html\n \u251c\u2500\u2500 static\n \u251c\u2500\u2500 styles.css\n \u2514\u2500\u2500 some_img.jpg\n\nIt will be transformed into (roughly) this directory structure:\n\n \u251c\u2500\u2500 code\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 test.py.html\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 test.rb.html\n \u251c\u2500\u2500 index.html\n \u2514\u2500\u2500 static\n \u251c\u2500\u2500 some_img.jpg\n \u2514\u2500\u2500 styles.css\n\n### Individual Files\n\nFor code, just write code as normal. Flockdoc will try to take care of\nformatting for you. The output will look a little like [Docco][docco].\n\nFor markdown, think [Jekyll][jekyll]: header with layout specified, and then\nyour code. YAML header with Markdown body. Example:\n\n title: Test\n context:\n key: value\n ---\n This is a test document with a key: {{ key }}\n\nDocuments are passed through Jinja2 rendering before they are output.\n\n[docco]: http://jashkenas.github.io/docco/\n[jekyll]: http://jekyllrb.com/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/brianhicks/flockdoc", "keywords": null, "license": "Apache", "maintainer": null, "maintainer_email": null, "name": "flockdoc", "package_url": "https://pypi.org/project/flockdoc/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/flockdoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/brianhicks/flockdoc" }, "release_url": "https://pypi.org/project/flockdoc/0.0.4/", "requires_dist": null, "requires_python": null, "summary": "Create example API documentation in multiple languages", "version": "0.0.4" }, "last_serial": 779688, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "b566110c20a579921c8290beabb2fe27", "sha256": "04727a539b24f96ec835ce7efa1dbebf1d553ce2b8e5b375f20c6c0ada876f71" }, "downloads": -1, "filename": "flockdoc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "b566110c20a579921c8290beabb2fe27", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4091, "upload_time": "2013-06-24T21:41:49", "url": "https://files.pythonhosted.org/packages/0b/eb/86ba7d7531586c2d1b2a64eb5dd1397d3cfbb53f855aa5114ed4d2492790/flockdoc-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "8785d40ce707c82bd0e55ff19e9aa6e7", "sha256": "9d9f157b65851c7f6cc79e43d55cecf89461c3629ea7a4dc6f489f50a17b26e8" }, "downloads": -1, "filename": "flockdoc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "8785d40ce707c82bd0e55ff19e9aa6e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4593, "upload_time": "2013-06-24T21:56:26", "url": "https://files.pythonhosted.org/packages/d9/45/a29bcbd3c0b396405e35bb689740cde734ea76d0020e3ee5aa7ffe37fb28/flockdoc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "77538ef0ebbe715bbe598e589c2008b7", "sha256": "d0d3038472e6619beb971f061b191c99b2bf301363da893c8e4456669a23c2cb" }, "downloads": -1, "filename": "flockdoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "77538ef0ebbe715bbe598e589c2008b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4654, "upload_time": "2013-06-25T15:41:02", "url": "https://files.pythonhosted.org/packages/d8/bd/7b6f2369b479f3720b8fdf29d966bf9fbe9d3dc7b9c62e7a26ce2f234417/flockdoc-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "b2f28d0418ec39c42c37a92c8b7131e9", "sha256": "42b4f0e6dcbe209341aebfb7540b1dd9910b36793b203b542c8a225b5f165807" }, "downloads": -1, "filename": "flockdoc-0.0.4.tar.gz", "has_sig": false, "md5_digest": "b2f28d0418ec39c42c37a92c8b7131e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4940, "upload_time": "2013-06-25T21:18:28", "url": "https://files.pythonhosted.org/packages/cc/1d/177a84671004aadb25437ce21349eac800d1324fb5f65a8de21d3a94f1c9/flockdoc-0.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b2f28d0418ec39c42c37a92c8b7131e9", "sha256": "42b4f0e6dcbe209341aebfb7540b1dd9910b36793b203b542c8a225b5f165807" }, "downloads": -1, "filename": "flockdoc-0.0.4.tar.gz", "has_sig": false, "md5_digest": "b2f28d0418ec39c42c37a92c8b7131e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4940, "upload_time": "2013-06-25T21:18:28", "url": "https://files.pythonhosted.org/packages/cc/1d/177a84671004aadb25437ce21349eac800d1324fb5f65a8de21d3a94f1c9/flockdoc-0.0.4.tar.gz" } ] }