============
jarn.viewdoc
============
------------------------------------
Python documentation viewer
------------------------------------
**viewdoc** is a Python package documentation viewer. It converts
reST-formatted text to HTML and displays it in a browser window.
The viewer is typically used to check a package's long description before
uploading it to PyPI.
Contents
========
* Installation_
* Usage_
* Options_
* Arguments_
* Configuration_
* Related_
* Changelog_
Installation
============
viewdoc works with Python 2.7 - 3.11 and all released versions of setuptools.
Use ``pip install jarn.viewdoc`` to install the ``viewdoc`` script.
Usage
=====
``viewdoc [options] [rst-file|egg-dir]``
Options
=======
``-s style, --style=style, or --style``
Select the custom style added to the HTML output.
``-b browser, --browser=browser``
Select the browser used for display. For a list of names see the
`webbrowser`_ module.
``-c config-file, --config-file=config-file``
Use config-file instead of the default ``~/.viewdoc``.
``-l, --list-styles``
List available styles and exit.
``-h, --help``
Print the help message and exit.
``-v, --version``
Print the version string and exit.
``--no-color``
Disable output colors.
``--no-browser``
Print HTML to stdout.
Arguments
=========
``rst-file``
The reST file to view.
``egg-dir``
The Python package whose long description to view.
Defaults to the current working directory.
.. _`webbrowser`: https://docs.python.org/3/library/webbrowser.html#webbrowser.register
Configuration
=============
viewdoc reads style information from its configuration file
``~/.viewdoc``. Edit this file to add your own styles.
Built-in Styles
---------------
``plain``
Browser default with margins.
``pypi``
New PyPI style with Google Fonts.
``sans``
PyPI-like style without Google Fonts (the default).
Related
=======
Also see our Python package releaser `jarn.mkrelease`_.
.. _`jarn.mkrelease`: https://github.com/Jarn/jarn.mkrelease
Changelog
=========
2.7 - 2023-09-23
----------------
- Update tox.ini for latest tox.
[stefan]
- Filter deprecated config warning.
[stefan]
- Fix invalid escape sequences.
[stefan]
- Fix tests for docutils >= 0.20.0.
[stefan]
2.6 - 2023-01-21
----------------
- Support setuptools >= 65.6.0.
[stefan]
2.5 - 2022-11-13
----------------
- Support Python 2.7 - 3.11.
[stefan]
- Do not require setup.py or setup.cfg if pyproject.toml exists.
[stefan]
- Filter some deprecation warnings.
[stefan]
- Warn if long_description metadata is missing.
[stefan]
2.4 - 2022-02-26
----------------
- Support Python 2.7 - 3.10.
[stefan]
- Fix code block background color in ``pypi`` style.
[stefan]
- Keep links underlined in ``pypi`` style.
[stefan]
- Add output colors.
[stefan]
- Do not require setup.py if setup.cfg exists.
[stefan]
- Move metadata to setup.cfg.
[stefan]
- Move tests out of ``jarn.viewdoc`` namespace.
[stefan]
- Include tests in sdist but not in wheel.
[stefan]
2.3 - 2019-01-28
----------------
- Support ``python -m jarn.viewdoc``.
[stefan]
2.2 - 2019-01-25
----------------
- Drop Python 2.6 support, add Python 3.7.
[stefan]
- Update styles in light of new PyPI (warehouse).
[stefan]
- Default to ``sans`` style because new PyPI uses Google Fonts.
[stefan]
- Convert dashes to underscores in config parser optionxform.
[stefan]
2.1 - 2017-10-06
----------------
- Add MANIFEST.in.
[stefan]
2.0 - 2017-07-20
----------------
- Update ``pypi`` stylesheet (grey code blocks).
[stefan]
- Automatically upgrade stylesheet information.
[stefan]
- Add -b option to specify the browser to use.
[stefan]
- Protect against bad or incomplete locale settings.
[stefan]
1.8 - 2017-01-30
----------------
- Support Python 2.6 - 3.6 without 2to3.
[stefan]
1.7 - 2014-03-22
----------------
- Update PyPI stylesheet links in the face of new python.org.
[stefan]
- Add new ``pypi`` style and rename previous one to ``classic``.
[stefan]
1.6 - 2013-11-21
----------------
- Support Python 3.x.
[stefan]
1.5 - 2012-07-11
----------------
- Restore Python 2.5 compatibility.
[stefan]
1.4 - 2011-11-25
----------------
- Warn if ``~/.viewdoc`` has errors instead of raising an exception.
[stefan]
1.3 - 2011-10-31
----------------
- Be more careful with what we put on the PYTHONPATH.
[stefan]
- Add ``small`` style to the default config.
[stefan]
1.2 - 2011-07-19
----------------
- Pass the PYTHONPATH to subprocesses.
[stefan]
- Avoid temp file when extracting the long description.
[stefan]
- Add -l option to list available styles.
[stefan]
- Add --*style* shortcut for -s *style*.
[stefan]
1.1 - 2011-02-08
----------------
- Add -s option to select styles on the command line.
[stefan]
- In ``pypi`` style, only underline reference links.
[stefan]
1.0 - 2010-12-30
----------------
- Initial release
[stefan]
Raw data
{
"_id": null,
"home_page": "https://github.com/Jarn/jarn.viewdoc",
"name": "jarn.viewdoc",
"maintainer": "",
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"maintainer_email": "",
"keywords": "view,rest,rst,package,docs,documentation,rst2html,long-description",
"author": "Stefan H. Holek",
"author_email": "stefan@epy.co.at",
"download_url": "https://files.pythonhosted.org/packages/85/ab/9b5197ca1380c2084647c44655cc225d4783e42aa28108186b9c1cb1fe55/jarn.viewdoc-2.7.tar.gz",
"platform": null,
"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.\nThe viewer is typically used to check a package's long description before\nuploading it to PyPI.\n\nContents\n========\n\n* Installation_\n* Usage_\n* Options_\n* Arguments_\n* Configuration_\n* Related_\n* Changelog_\n\nInstallation\n============\n\nviewdoc works with Python 2.7 - 3.11 and all released versions of setuptools.\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``--no-color``\n Disable output colors.\n\n``--no-browser``\n Print HTML to stdout.\n\nArguments\n=========\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\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.7 - 2023-09-23\n----------------\n\n- Update tox.ini for latest tox.\n [stefan]\n\n- Filter deprecated config warning.\n [stefan]\n\n- Fix invalid escape sequences.\n [stefan]\n\n- Fix tests for docutils >= 0.20.0.\n [stefan]\n\n2.6 - 2023-01-21\n----------------\n\n- Support setuptools >= 65.6.0.\n [stefan]\n\n2.5 - 2022-11-13\n----------------\n\n- Support Python 2.7 - 3.11.\n [stefan]\n\n- Do not require setup.py or setup.cfg if pyproject.toml exists.\n [stefan]\n\n- Filter some deprecation warnings.\n [stefan]\n\n- Warn if long_description metadata is missing.\n [stefan]\n\n2.4 - 2022-02-26\n----------------\n\n- Support Python 2.7 - 3.10.\n [stefan]\n\n- Fix code block background color in ``pypi`` style.\n [stefan]\n\n- Keep links underlined in ``pypi`` style.\n [stefan]\n\n- Add output colors.\n [stefan]\n\n- Do not require setup.py if setup.cfg exists.\n [stefan]\n\n- Move metadata to setup.cfg.\n [stefan]\n\n- Move tests out of ``jarn.viewdoc`` namespace.\n [stefan]\n\n- Include tests in sdist but not in wheel.\n [stefan]\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",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Python documentation viewer",
"version": "2.7",
"project_urls": {
"Homepage": "https://github.com/Jarn/jarn.viewdoc"
},
"split_keywords": [
"view",
"rest",
"rst",
"package",
"docs",
"documentation",
"rst2html",
"long-description"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef971939b2dd67b795edb7b3f561fff15caec6b775b762bdd98d21c8be32fc9b",
"md5": "e0995848c9807f6f86f7000c243d8909",
"sha256": "d40338a6f0761b610b442a77f3bf185e2ab67fd603914444020fb95865146a94"
},
"downloads": -1,
"filename": "jarn.viewdoc-2.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0995848c9807f6f86f7000c243d8909",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 14107,
"upload_time": "2023-09-23T07:32:45",
"upload_time_iso_8601": "2023-09-23T07:32:45.063897Z",
"url": "https://files.pythonhosted.org/packages/ef/97/1939b2dd67b795edb7b3f561fff15caec6b775b762bdd98d21c8be32fc9b/jarn.viewdoc-2.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85ab9b5197ca1380c2084647c44655cc225d4783e42aa28108186b9c1cb1fe55",
"md5": "6ff1adae406ee55412019821f5ffc92f",
"sha256": "e9fc2b4fb46e0391073fa0ce01893cd1f8bf55395d3bab5618691bc3b00acb2c"
},
"downloads": -1,
"filename": "jarn.viewdoc-2.7.tar.gz",
"has_sig": false,
"md5_digest": "6ff1adae406ee55412019821f5ffc92f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 15658,
"upload_time": "2023-09-23T07:32:46",
"upload_time_iso_8601": "2023-09-23T07:32:46.893316Z",
"url": "https://files.pythonhosted.org/packages/85/ab/9b5197ca1380c2084647c44655cc225d4783e42aa28108186b9c1cb1fe55/jarn.viewdoc-2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-23 07:32:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Jarn",
"github_project": "jarn.viewdoc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "jarn.viewdoc"
}
JSON
