{ "info": { "author": "Obscure Metaphor", "author_email": "hello@obscuremetaphor.co.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "## OMDOC\n\nOMDOC is a lightweight documentation builder that utilises [jinja2][0] templates as placeholders for markdown and code.\n\nCode samples are parsed with [pygments][1] and the content is parsed with markdown.\n\nYou're in total control of how it looks, feels and responds to different devices.\n\nNo magic, it's plain ol' html with a dash of jinja, markdown and pygments. \n\n## Features\n\n### code\n\nAny blocks of code inside code tags are parsed; eg\n\n```\npip install omdoc\n```\n\n\nAn attempt is made to match the lang attribute against [known pygments lexers][2]. If no match is found it defaults to python.\n\n### Markdown \n\nAny content inside of ...\n\n```{% markdown %} stuff to mark down {% endmarkdown%} ```\n\n... gets marked down.\n\n\n\n## Installation\n\n```pip install omdoc```\n\n## Usage\n\n1. Make folder for docs\n2. Create layout.html inside of docs folder\n2. Style as you see fit\n3. Create pages that inherit layout.html in docs\n5. cd 'docs'\n6. run ``omdoc``\n\nYour documentation will now be in /_build\n\n## What about static media?\n\nProceed as you would building a a normal site. Folders inside of `docs/` get copied into the final build. Just make sure to use relative paths in your html & css.\n\n\n## Status\n\nEarly alpha. \n\n## Known caveats\n\n### Nested Folders\n\nDoesn't support nested folders for docs so `docs/about/this.html` doesn't work. This will get fixed later one \n\n[0]: http://jinja.pocoo.org/docs/\n[1]: http://pygments.org/\n[2]: http://pygments.org/docs/lexers/", "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/obscuremetaphor/omdoc", "keywords": null, "license": "BSD 3 Clause", "maintainer": null, "maintainer_email": null, "name": "omdoc", "package_url": "https://pypi.org/project/omdoc/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/omdoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/obscuremetaphor/omdoc" }, "release_url": "https://pypi.org/project/omdoc/0.1.3.alpha/", "requires_dist": null, "requires_python": null, "summary": "A lightweight documentation builder.", "version": "0.1.3.alpha" }, "last_serial": 795704, "releases": { "0.1.1.alpha": [ { "comment_text": "", "digests": { "md5": "28f52080cf38d96cd9ab59036c6ec5ae", "sha256": "db30becf82685fed4aefba1a344df5e6021ed2bd401312e0ae225aee23fabad2" }, "downloads": -1, "filename": "omdoc-0.1.1.alpha.tar.gz", "has_sig": false, "md5_digest": "28f52080cf38d96cd9ab59036c6ec5ae", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2697, "upload_time": "2012-07-13T12:04:25", "url": "https://files.pythonhosted.org/packages/4c/5b/fb40132d49ecc6a3e1f3b23c7917b6252a20551c6f9fec561a18ae10a423/omdoc-0.1.1.alpha.tar.gz" } ], "0.1.2.alpha": [ { "comment_text": "", "digests": { "md5": "bcff0327a5441958d8fdcea78d5192c7", "sha256": "6b09bcabfbe006b016780b343fd4568da8ffaa61d72c92304dbded04c173639f" }, "downloads": -1, "filename": "omdoc-0.1.2.alpha.tar.gz", "has_sig": false, "md5_digest": "bcff0327a5441958d8fdcea78d5192c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2811, "upload_time": "2012-07-13T13:11:01", "url": "https://files.pythonhosted.org/packages/7d/5e/6148174031ddf9ab3fd4058105046c8e54974f737735173ac13da5b13db0/omdoc-0.1.2.alpha.tar.gz" } ], "0.1.3.alpha": [ { "comment_text": "", "digests": { "md5": "37dccb73bc396563ca55ad46101a2d39", "sha256": "ea7d06e76ba913855e810f16ab81c4373cc775f66af1d1e386ab94b1cad8a29d" }, "downloads": -1, "filename": "omdoc-0.1.3.alpha.tar.gz", "has_sig": false, "md5_digest": "37dccb73bc396563ca55ad46101a2d39", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4045, "upload_time": "2012-07-13T18:58:17", "url": "https://files.pythonhosted.org/packages/20/1c/eb736bd207cead1b3352f9cfd4af0e156a71dff11d870aa77e1c5b1b0699/omdoc-0.1.3.alpha.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "37dccb73bc396563ca55ad46101a2d39", "sha256": "ea7d06e76ba913855e810f16ab81c4373cc775f66af1d1e386ab94b1cad8a29d" }, "downloads": -1, "filename": "omdoc-0.1.3.alpha.tar.gz", "has_sig": false, "md5_digest": "37dccb73bc396563ca55ad46101a2d39", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4045, "upload_time": "2012-07-13T18:58:17", "url": "https://files.pythonhosted.org/packages/20/1c/eb736bd207cead1b3352f9cfd4af0e156a71dff11d870aa77e1c5b1b0699/omdoc-0.1.3.alpha.tar.gz" } ] }