Package: jarn.viewdoc
viewdocis 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.ContentsInstallationUsageOptionsArgumentsConfigurationRelatedChangelogInstallationviewdoc works with Python 2.7 - 3.11 and all released versions of setuptools.Usepip install jarn.viewdocto install theviewdocscript.Usageviewdoc [options][rst-file|egg-dir]Options-sstyle,--style=style,or--styleSelect the custom style added to the HTML output.-bbrowser,--browser=browserSelect the browser used for display. For a list of names see thewebbrowsermodule.-cconfig-file,--config-file=config-fileUse config-file instead of the default~/.viewdoc.-l,--list-stylesList available styles and exit.-h,--helpPrint the help message and exit.-v,--versionPrint the version string and exit.--no-colorDisable output colors.--no-browserPrint HTML to stdout.Argumentsrst-fileThe reST file to view.egg-dirThe Python package whose long description to view.
Defaults to the current working directory.Configurationviewdoc reads style information from its configuration file~/.viewdoc. Edit this file to add your own styles.Built-in StylesplainBrowser default with margins.pypiNew PyPI style with Google Fonts.sansPyPI-like style without Google Fonts (the default).RelatedAlso see our Python package releaserjarn.mkrelease.Changelog2.7 - 2023-09-23Update 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-21Support setuptools >= 65.6.0.
[stefan]2.5 - 2022-11-13Support 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-26Support Python 2.7 - 3.10.
[stefan]Fix code block background color inpypistyle.
[stefan]Keep links underlined inpypistyle.
[stefan]Add output colors.
[stefan]Do not require setup.py if setup.cfg exists.
[stefan]Move metadata to setup.cfg.
[stefan]Move tests out ofjarn.viewdocnamespace.
[stefan]Include tests in sdist but not in wheel.
[stefan]2.3 - 2019-01-28Supportpython-mjarn.viewdoc.
[stefan]2.2 - 2019-01-25Drop Python 2.6 support, add Python 3.7.
[stefan]Update styles in light of new PyPI (warehouse).
[stefan]Default tosansstyle because new PyPI uses Google Fonts.
[stefan]Convert dashes to underscores in config parser optionxform.
[stefan]2.1 - 2017-10-06Add MANIFEST.in.
[stefan]2.0 - 2017-07-20Updatepypistylesheet (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-30Support Python 2.6 - 3.6 without 2to3.
[stefan]1.7 - 2014-03-22Update PyPI stylesheet links in the face of new python.org.
[stefan]Add newpypistyle and rename previous one toclassic.
[stefan]1.6 - 2013-11-21Support Python 3.x.
[stefan]1.5 - 2012-07-11Restore Python 2.5 compatibility.
[stefan]1.4 - 2011-11-25Warn if~/.viewdochas errors instead of raising an exception.
[stefan]1.3 - 2011-10-31Be more careful with what we put on the PYTHONPATH.
[stefan]Addsmallstyle to the default config.
[stefan]1.2 - 2011-07-19Pass the PYTHONPATH to subprocesses.
[stefan]Avoid temp file when extracting the long description.
[stefan]Add -l option to list available styles.
[stefan]Add –styleshortcut for -sstyle.
[stefan]1.1 - 2011-02-08Add -s option to select styles on the command line.
[stefan]Inpypistyle, only underline reference links.
[stefan]1.0 - 2010-12-30Initial release
[stefan]