{ "info": { "author": "Xavier Bruhiere", "author_email": "xavier.bruhiere@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Documentation" ], "description": "Okdoc\n=====\n\n> Automatic documentation website, with style and laziness\n\n\nWrite your documentation as markdown files, a tiny yaml configuration and just\nfire up *okdoc* to build a beautiful website around it, ready to deploy on\nheroku.\n\n\nInstallation\n------------\n\n`pip` will be here for the next commit, in the meantime let's build from source\n\n```console\n$ git clone https://github.com/hackliff/okdoc\n$ cd okdoc && python setup.py install\n$ # ...\n$ okdoc --help\n```\n\n\nRules for a compliant okdoc project\n---------------------------------\n\n* An `index.html.md` in the root directory. It will be the first page on the\n website\n\n* Directories and files in `articles/` are sections and articles. A file or\n directory named `awesome-part` will become `Awesome Part`.\n\n* A well informed `project.yml`, like below\n\n```yaml\ntitle: Intuition Lab\nname: intuition\nauthor: Xavier Bruhiere\nkeywords: finance, trading, quant\ndescription: Automated quantitative trading kit, for hackers\ncopyright: 2014 Xavier Bruhiere\n\nlinks:\n home: https://github.com/hackliff/intuition\n blog: http://hivetech.github.io\n about: www.google.com\n signup: https://app.wercker.com/users/new\n\ncontact:\n twitter: XavierBruhiere\n support_email: xavier.bruhiere@gmail.com\n\ngithub:\n user: hackliff\n repo: intuition\n```\n\n\nBam\n---\n\n```console\n$ okdoc build --from /path/to/the/doc --to /where/you/want\n```\n\nYou're done. Test it locally:\n\n```console\n$ cd /where/you/want\n$ # Remove .ruby-version, or install ruby 2.0.0-p247\n$ bundle install\n$ bundle exec middleman build\n$ bundle exec middleman server\n$ # This is even ready for heroku\n```\n\n\nCredits\n-------\n\nKudos to the [wercker team](wercker.com) who initially built and open sourced\ntheir [devcenter](devcenter.wercker.com) website !", "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/hackliff/okdoc", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "okdoc", "package_url": "https://pypi.org/project/okdoc/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/okdoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/hackliff/okdoc" }, "release_url": "https://pypi.org/project/okdoc/0.0.3/", "requires_dist": null, "requires_python": null, "summary": "Automatic documentation website, with style and lazyness", "version": "0.0.3" }, "last_serial": 1034684, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "c3ab5c245ba1100aab41795cb2858d4a", "sha256": "e2d9fb500dfb9b4ec6312c5a6dbb0569fada66bf9d934494f29697e46678237d" }, "downloads": -1, "filename": "okdoc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "c3ab5c245ba1100aab41795cb2858d4a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3934, "upload_time": "2014-01-22T15:25:29", "url": "https://files.pythonhosted.org/packages/b5/6a/e31a7ed7fdb91ee5302c8a9991ca84d26a4ca997a555e0cc24195ef29528/okdoc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "30eb0886658dbb3d8f321195490e6fda", "sha256": "8a293e8fdc5e93d9224fe407c3ac091dbc8058791ca0fc41f76024913c7770a8" }, "downloads": -1, "filename": "okdoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "30eb0886658dbb3d8f321195490e6fda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4605, "upload_time": "2014-03-19T09:28:15", "url": "https://files.pythonhosted.org/packages/2d/11/0ea186d46a8f2a9f841fd293bd20da968545e6776f0a0d8d306f85955e2d/okdoc-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "30eb0886658dbb3d8f321195490e6fda", "sha256": "8a293e8fdc5e93d9224fe407c3ac091dbc8058791ca0fc41f76024913c7770a8" }, "downloads": -1, "filename": "okdoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "30eb0886658dbb3d8f321195490e6fda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4605, "upload_time": "2014-03-19T09:28:15", "url": "https://files.pythonhosted.org/packages/2d/11/0ea186d46a8f2a9f841fd293bd20da968545e6776f0a0d8d306f85955e2d/okdoc-0.0.3.tar.gz" } ] }