{ "info": { "author": "Jeff Hammel", "author_email": "jhammel@mozilla.com", "bugtrack_url": null, "classifiers": [], "description": "# DocumentIt\n\nDocumentIt renders [markdown]() syntax to HTML and uploads it to the \n[Mozilla Developer Network](https://developer.mozilla.org/)\n\nIt is run by:\n\n document-it [options] manifest [manifest] [...]\n\nSee `document-it --help` for options. It will render to a local\ntemporary directory by default but you can specify its output with\n`--dest` (although you will need to pass `--user` and `--password` to\nPOST data).\n\n\n## Manifests\n\nA manifest is in the form:\n\n relative_file_path page_name\n ...\n\nThe file path is relative to the manifest.\n\n(*TODO: more columns of options may be added in subsequent release to\ne.g. specify input format and expand macros)\n\nAn example manifest is at\nhttp://k0s.org/mozilla/hg/DocumentIt/file/tip/example.manifest\n\n\n## TODO\n\nCurrently, to POST, DocumentIt assumes `curl` is available on the\npath. This is an obvious deficiency and it should be replaced with a\nrequest from (e.g.) `urllib2`.\n\nIn addition to http://developer.mozilla.org it would be nice to POST\nto `http://wiki.mozilla.org` as well. This would allow staging\ndocuments at `wiki.mozilla.org` and then moving to MDN.\n\nThere are other features that would be nice to have:\n\n- inclusion of other files\n- inclusion of `--help` documentation\n\nIn general the approach taken shouldn't compromise the general\napproach that the documentation should be the documentation, not\npre-documentation. This may be achieved by the use of (e.g. regex)\nmacros. For instance:\n\n append(--help.*$,shell(mozmill --help))", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://k0s.org/mozilla/hg/DocumentIt", "keywords": "mozilla", "license": "MPL", "maintainer": null, "maintainer_email": null, "name": "document_it", "package_url": "https://pypi.org/project/document_it/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/document_it/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://k0s.org/mozilla/hg/DocumentIt" }, "release_url": "https://pypi.org/project/document_it/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "mirror text documentation to MDN", "version": "0.1.1" }, "last_serial": 791306, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "072b59bd64643b25630e089f25a8784d", "sha256": "d724ebd6710505aa34cd5a7785b652b59bb9da788d83da7f28301aa4021fba35" }, "downloads": -1, "filename": "document_it-0.1.tar.gz", "has_sig": false, "md5_digest": "072b59bd64643b25630e089f25a8784d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4550, "upload_time": "2011-08-04T05:00:11", "url": "https://files.pythonhosted.org/packages/58/2f/94ea68001c0ccee4d04b61eedcb865270970a1fc962b2f6ffa01e7a7d331/document_it-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "c95b13944d896ea9c90edcdbf39e0a0e", "sha256": "d8ade28736bbd6e622d34bbc544d6e22cc495efe5f6ae8b9031f64ba598f02da" }, "downloads": -1, "filename": "document_it-0.1.1.tar.gz", "has_sig": false, "md5_digest": "c95b13944d896ea9c90edcdbf39e0a0e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4600, "upload_time": "2011-08-05T18:13:40", "url": "https://files.pythonhosted.org/packages/cd/d1/a5f4fcff2994723b52ab314a4f8e803cad947312b8ba933dc89afda2bc7f/document_it-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c95b13944d896ea9c90edcdbf39e0a0e", "sha256": "d8ade28736bbd6e622d34bbc544d6e22cc495efe5f6ae8b9031f64ba598f02da" }, "downloads": -1, "filename": "document_it-0.1.1.tar.gz", "has_sig": false, "md5_digest": "c95b13944d896ea9c90edcdbf39e0a0e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4600, "upload_time": "2011-08-05T18:13:40", "url": "https://files.pythonhosted.org/packages/cd/d1/a5f4fcff2994723b52ab314a4f8e803cad947312b8ba933dc89afda2bc7f/document_it-0.1.1.tar.gz" } ] }