{ "info": { "author": "Stefan H. Holek", "author_email": "stefan@epy.co.at", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "============\njarn.viewdoc\n============\n------------------------------------\nPython documentation viewer\n------------------------------------\n\n**viewdoc** is a Python package documentation viewer. It converts\nreST-formatted text to HTML and displays it in a browser window.\n\nviewdoc is typically used to check a package's long description before\nuploading it to PyPI.\n\nInstallation\n============\n\nviewdoc works with Python 2.7 - 3.7 and all released versions of setuptools\nand distribute.\n\nUse ``pip install jarn.viewdoc`` to install the ``viewdoc`` script.\n\nUsage\n=====\n\n``viewdoc [options] [rst-file | egg-dir]``\n\nOptions\n=======\n\n``-s style, --style=style, or --style``\n Select the custom style added to the HTML output.\n\n``-b browser, --browser=browser``\n Select the browser used for display. For a list of names see the\n `webbrowser`_ module.\n\n``-c config-file, --config-file=config-file``\n Use config-file instead of the default ``~/.viewdoc``.\n\n``-l, --list-styles``\n List available styles and exit.\n\n``-h, --help``\n Print the help message and exit.\n\n``-v, --version``\n Print the version string and exit.\n\n``rst-file``\n The reST file to view.\n\n``egg-dir``\n The Python package whose long description to view.\n Defaults to the current working directory.\n\n.. _`webbrowser`: https://docs.python.org/3/library/webbrowser.html#webbrowser.register\n\nConfiguration\n=============\n\nviewdoc reads style information from its configuration file\n``~/.viewdoc``. Edit this file to add your own styles.\n\nBuilt-in Styles\n---------------\n\n``plain``\n Browser default with margins.\n\n``pypi``\n New PyPI style with Google Fonts.\n\n``sans``\n PyPI-like style without Google Fonts (the default).\n\n\nKnown Bugs\n============\n\nIf you are on macOS Sierra be aware of https://bugs.python.org/issue30392. As\na workaround specify the browser on the command line::\n\n $ viewdoc -b safari src/my.package\n\nor use the configuration file::\n\n [viewdoc]\n browser = safari\n\nRelated\n=======\n\nAlso see our Python package releaser `jarn.mkrelease`_.\n\n.. _`jarn.mkrelease`: https://github.com/Jarn/jarn.mkrelease\n\n\nChangelog\n=========\n\n2.3 - 2019-01-28\n----------------\n\n- Support ``python -m jarn.viewdoc``.\n [stefan]\n\n2.2 - 2019-01-25\n----------------\n\n- Drop Python 2.6 support, add Python 3.7.\n [stefan]\n\n- Update styles in light of new PyPI (warehouse).\n [stefan]\n\n- Default to ``sans`` style because new PyPI uses Google Fonts.\n [stefan]\n\n- Convert dashes to underscores in config parser optionxform.\n [stefan]\n\n2.1 - 2017-10-06\n----------------\n\n- Add MANIFEST.in.\n [stefan]\n\n2.0 - 2017-07-20\n----------------\n\n- Update ``pypi`` stylesheet (grey code blocks).\n [stefan]\n\n- Automatically upgrade stylesheet information.\n [stefan]\n\n- Add -b option to specify the browser to use.\n [stefan]\n\n- Protect against bad or incomplete locale settings.\n [stefan]\n\n1.8 - 2017-01-30\n----------------\n\n- Support Python 2.6 - 3.6 without 2to3.\n [stefan]\n\n1.7 - 2014-03-22\n----------------\n\n- Update PyPI stylesheet links in the face of new python.org.\n [stefan]\n\n- Add new ``pypi`` style and rename previous one to ``classic``.\n [stefan]\n\n1.6 - 2013-11-21\n----------------\n\n- Support Python 3.x.\n [stefan]\n\n1.5 - 2012-07-11\n----------------\n\n- Restore Python 2.5 compatibility.\n [stefan]\n\n1.4 - 2011-11-25\n----------------\n\n- Warn if ``~/.viewdoc`` has errors instead of raising an exception.\n [stefan]\n\n1.3 - 2011-10-31\n----------------\n\n- Be more careful with what we put on the PYTHONPATH.\n [stefan]\n\n- Add ``small`` style to the default config.\n [stefan]\n\n1.2 - 2011-07-19\n----------------\n\n- Pass the PYTHONPATH to subprocesses.\n [stefan]\n\n- Avoid temp file when extracting the long description.\n [stefan]\n\n- Add -l option to list available styles.\n [stefan]\n\n- Add --*style* shortcut for -s *style*.\n [stefan]\n\n1.1 - 2011-02-08\n----------------\n\n- Add -s option to select styles on the command line.\n [stefan]\n\n- In ``pypi`` style, only underline reference links.\n [stefan]\n\n1.0 - 2010-12-30\n----------------\n\n- Initial release\n [stefan]\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Jarn/jarn.viewdoc", "keywords": "view rest rst package docs documentation rst2html long-description", "license": "BSD-2-Clause", "maintainer": "", "maintainer_email": "", "name": "jarn.viewdoc", "package_url": "https://pypi.org/project/jarn.viewdoc/", "platform": "", "project_url": "https://pypi.org/project/jarn.viewdoc/", "project_urls": { "Homepage": "https://github.com/Jarn/jarn.viewdoc" }, "release_url": "https://pypi.org/project/jarn.viewdoc/2.3/", "requires_dist": null, "requires_python": "", "summary": "Python documentation viewer", "version": "2.3" }, "last_serial": 4751514, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "4bdbee1daad962976d0fd3c7fe8c15bb", "sha256": "fa9c073fbcae6833d8ab96db7b5fb7f0b9377f8800efed9225229c26ead98b3c" }, "downloads": -1, "filename": "jarn.viewdoc-1.0.zip", "has_sig": false, "md5_digest": "4bdbee1daad962976d0fd3c7fe8c15bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8060, "upload_time": "2010-12-30T15:10:48", "url": "https://files.pythonhosted.org/packages/50/bc/cfc5006f5701e9103c2e263bd87be2365aa46dd210078053464722c17451/jarn.viewdoc-1.0.zip" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "a29e885e9a5d66b1243bb397a46bb833", "sha256": "e241f217a5de1dfc2f840881576dd57954b56832221467d5c506c99a8d5d9bae" }, "downloads": -1, "filename": "jarn.viewdoc-1.1.zip", "has_sig": false, "md5_digest": "a29e885e9a5d66b1243bb397a46bb833", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8920, "upload_time": "2011-02-08T22:43:44", "url": "https://files.pythonhosted.org/packages/81/e5/27f013e9c5389db864fc92d5b5bbc09b2aefa3438d1553bb240722495e7c/jarn.viewdoc-1.1.zip" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "70f1ad009207cba7b50c7fb16032bf4e", "sha256": "fa0432103f9fbc4644a3468af8549d3fe866abac8352bf8a5cdbe20eb172610c" }, "downloads": -1, "filename": "jarn.viewdoc-1.2.zip", "has_sig": false, "md5_digest": "70f1ad009207cba7b50c7fb16032bf4e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9759, "upload_time": "2011-07-19T15:45:33", "url": "https://files.pythonhosted.org/packages/1b/5a/33df209c80f4fee020a7f2f28edb273c64e877657412835f105a78864895/jarn.viewdoc-1.2.zip" } ], "1.3": [ { "comment_text": "", "digests": { "md5": "aa48d5bb024bb80c3aed2a647f6b392b", "sha256": "c6329268bea4f7068a0d091fc137acc00ec677ba6f7cf15df00c836409352410" }, "downloads": -1, "filename": "jarn.viewdoc-1.3.zip", "has_sig": false, "md5_digest": "aa48d5bb024bb80c3aed2a647f6b392b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10445, "upload_time": "2011-10-31T12:07:40", "url": "https://files.pythonhosted.org/packages/e1/2c/3761dc1ce66e8579a9b7384902f7a08d8b7d82626459abb08725d4a53772/jarn.viewdoc-1.3.zip" } ], "1.4": [ { "comment_text": "", "digests": { "md5": "773f3bd1b1841d4429a4e5af0a256e89", "sha256": "93069aae283d5b07fc25eb2b4fdff2a92ca66b9fe0cafee5f4c56f5bc0242d37" }, "downloads": -1, "filename": "jarn.viewdoc-1.4.zip", "has_sig": false, "md5_digest": "773f3bd1b1841d4429a4e5af0a256e89", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10596, "upload_time": "2011-11-25T12:49:22", "url": "https://files.pythonhosted.org/packages/bc/70/e37481b79acd4f44cc28b60920d133d286831530af35d586d79d0a84b5d8/jarn.viewdoc-1.4.zip" } ], "1.5": [ { "comment_text": "", "digests": { "md5": "9e2faac842916403a70502d877f0a049", "sha256": "40a469b451a0d63999d8a5e8b3da9c2ca9aea0188d6648d6486f77a68bfb040b" }, "downloads": -1, "filename": "jarn.viewdoc-1.5.zip", "has_sig": false, "md5_digest": "9e2faac842916403a70502d877f0a049", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10708, "upload_time": "2012-07-11T14:32:19", "url": "https://files.pythonhosted.org/packages/57/e4/9ca436275e053aa2121828a186fc0fe6d1d9ff979237f87712a409d4c86a/jarn.viewdoc-1.5.zip" } ], "1.6": [ { "comment_text": "", "digests": { "md5": "6bee124883fbefb14b359a6e734b6817", "sha256": "6053b19cacb987fa666d71bcec9023e984a5435e54a59a96ed6f0faddc1f79dc" }, "downloads": -1, "filename": "jarn.viewdoc-1.6.zip", "has_sig": false, "md5_digest": "6bee124883fbefb14b359a6e734b6817", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12726, "upload_time": "2013-11-21T10:00:17", "url": "https://files.pythonhosted.org/packages/85/67/921fd54abbc006d9f352bb85c007489f6de485f2bf4d93a43772beaf2c27/jarn.viewdoc-1.6.zip" } ], "1.7": [ { "comment_text": "", "digests": { "md5": "667c2318a9648e7b81408dea6f0743a5", "sha256": "15ab42faf57c7d1555bd0a9a483045cfd61a5fe3302f243508062127a38d2d29" }, "downloads": -1, "filename": "jarn.viewdoc-1.7.zip", "has_sig": false, "md5_digest": "667c2318a9648e7b81408dea6f0743a5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13057, "upload_time": "2014-03-22T18:02:01", "url": "https://files.pythonhosted.org/packages/69/0c/b47cd1af53e13560c9b57cc367b83fe69d3c554493c5a884c5ebb40562fe/jarn.viewdoc-1.7.zip" } ], "1.8": [ { "comment_text": "", "digests": { "md5": "742b2e65bdd72f19546c25be14043a38", "sha256": "b1c5769290f20fe1312a307c14c7d032373f9cb7676d474ee636c40f733dd035" }, "downloads": -1, "filename": "jarn.viewdoc-1.8.zip", "has_sig": false, "md5_digest": "742b2e65bdd72f19546c25be14043a38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13973, "upload_time": "2017-01-31T10:41:14", "url": "https://files.pythonhosted.org/packages/17/ca/9ad019607ac89329df8404b00262437873c6b0440ed1a88b90f802391a5e/jarn.viewdoc-1.8.zip" } ], "2.0": [ { "comment_text": "", "digests": { "md5": "09de7c5adce1910dddfef408ff1bf3d2", "sha256": "016923b68b95b77478af43bab7b3f4ac1fc0c967e0effa04a36124c12b155579" }, "downloads": -1, "filename": "jarn.viewdoc-2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "09de7c5adce1910dddfef408ff1bf3d2", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 15291, "upload_time": "2017-07-20T06:50:45", "url": "https://files.pythonhosted.org/packages/94/20/e9729506c8c78f24b96605d17cb1404bf5d8d365761b9c41196e94c483c9/jarn.viewdoc-2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed4895fa2d7febc63279ffbe477706c0", "sha256": "6b245e8e435753a8e84c43b36577280f95e4d59ede7f484eb5a2ea77e4a99278" }, "downloads": -1, "filename": "jarn.viewdoc-2.0.zip", "has_sig": false, "md5_digest": "ed4895fa2d7febc63279ffbe477706c0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19078, "upload_time": "2017-07-20T06:50:41", "url": "https://files.pythonhosted.org/packages/0d/a3/d5251d2baf527c73fc4d729b83f25fd6cf58f053dedfec609c43048fd783/jarn.viewdoc-2.0.zip" } ], "2.1": [ { "comment_text": "", "digests": { "md5": "c3e7f1f1f4ae7244f81471098c5a5edd", "sha256": "5b4e5b845b41ba4c67d9d4c90f4965fb67cf6fbf6fad704f4009f614377952a8" }, "downloads": -1, "filename": "jarn.viewdoc-2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c3e7f1f1f4ae7244f81471098c5a5edd", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 15348, "upload_time": "2017-10-06T07:35:52", "url": "https://files.pythonhosted.org/packages/b5/8e/9a6724d890e7cf250d0db9e409d31e115f59222a7cb23ca70885600f6dc4/jarn.viewdoc-2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dec87b39128b7dc61d8f825157b1f028", "sha256": "caddfb2d2a85cf2bd547f7e6884c92ff0b975deb4f1d343870716190cf2d559d" }, "downloads": -1, "filename": "jarn.viewdoc-2.1.zip", "has_sig": false, "md5_digest": "dec87b39128b7dc61d8f825157b1f028", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19335, "upload_time": "2017-10-06T07:35:48", "url": "https://files.pythonhosted.org/packages/45/bc/4478eb64c190e0cd0177ddfcc949130eb4a2e5b2ba51cb33e6140a4361b3/jarn.viewdoc-2.1.zip" } ], "2.2": [ { "comment_text": "", "digests": { "md5": "1ce91a3aa079b0d882f2de9b0ae406b9", "sha256": "02dffdbf9247760b8d2e28668f40c2b6ba443eebc46d55386863035007d486c6" }, "downloads": -1, "filename": "jarn.viewdoc-2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1ce91a3aa079b0d882f2de9b0ae406b9", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 14360, "upload_time": "2019-01-25T17:54:43", "url": "https://files.pythonhosted.org/packages/1e/3a/5abf4dfcae7bd41887109a08d58186faf2908f1e0390caa2530173982bf4/jarn.viewdoc-2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5355119cf0a58e01150fe935db209d63", "sha256": "e25a2850ce64fa6ec1fc996e935cff9daa9144228233331dfb36e8da46b90b66" }, "downloads": -1, "filename": "jarn.viewdoc-2.2.zip", "has_sig": false, "md5_digest": "5355119cf0a58e01150fe935db209d63", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20930, "upload_time": "2019-01-25T17:54:36", "url": "https://files.pythonhosted.org/packages/c3/6f/e2d1fa5f877a24f4add8ec46d647db9f05dbf6e884899702b60acd08b62c/jarn.viewdoc-2.2.zip" } ], "2.3": [ { "comment_text": "", "digests": { "md5": "ba67ea0e672c5a6b14e4a70c8567cb04", "sha256": "cc64c18a89668f1dd439d874b38cd7116b9a0aee62756d38295c82cc31de0abf" }, "downloads": -1, "filename": "jarn.viewdoc-2.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ba67ea0e672c5a6b14e4a70c8567cb04", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 14663, "upload_time": "2019-01-28T19:22:46", "url": "https://files.pythonhosted.org/packages/45/a2/f492f820f85e8a79b1884ec0021d135502a3a34b75f8eec1ae7205e7ef81/jarn.viewdoc-2.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1839f00346082f18161e76c3049b6b91", "sha256": "36ef1ebde43ee058d7ce9d24e7d96305f8469bd6ce546f5ac4e1927a958a307a" }, "downloads": -1, "filename": "jarn.viewdoc-2.3.zip", "has_sig": false, "md5_digest": "1839f00346082f18161e76c3049b6b91", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21269, "upload_time": "2019-01-28T19:22:41", "url": "https://files.pythonhosted.org/packages/33/cd/e6e9ab725904adf3118d1b0be1552d298c855cf9980b733c5267c02d6fb1/jarn.viewdoc-2.3.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ba67ea0e672c5a6b14e4a70c8567cb04", "sha256": "cc64c18a89668f1dd439d874b38cd7116b9a0aee62756d38295c82cc31de0abf" }, "downloads": -1, "filename": "jarn.viewdoc-2.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ba67ea0e672c5a6b14e4a70c8567cb04", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 14663, "upload_time": "2019-01-28T19:22:46", "url": "https://files.pythonhosted.org/packages/45/a2/f492f820f85e8a79b1884ec0021d135502a3a34b75f8eec1ae7205e7ef81/jarn.viewdoc-2.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1839f00346082f18161e76c3049b6b91", "sha256": "36ef1ebde43ee058d7ce9d24e7d96305f8469bd6ce546f5ac4e1927a958a307a" }, "downloads": -1, "filename": "jarn.viewdoc-2.3.zip", "has_sig": false, "md5_digest": "1839f00346082f18161e76c3049b6b91", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21269, "upload_time": "2019-01-28T19:22:41", "url": "https://files.pythonhosted.org/packages/33/cd/e6e9ab725904adf3118d1b0be1552d298c855cf9980b733c5267c02d6fb1/jarn.viewdoc-2.3.zip" } ] }