跳转到主要内容

Python文档查看器

项目描述

viewdoc 是一个Python包文档查看器。它将reST格式化的文本转换为HTML,并在浏览器窗口中显示。查看器通常用于在将包上传到PyPI之前检查包的长描述。

内容

安装

viewdoc 与Python 2.7 - 3.11以及setuptools的所有发布版本兼容。

使用 pip install jarn.viewdoc 安装 viewdoc 脚本。

使用

viewdoc [options] [rst-file|egg-dir]

选项

-s style, --style=style,--style

选择要添加到HTML输出的自定义样式。

-b browser, --browser=browser

选择用于显示的浏览器。有关名称列表,请参阅 webbrowser 模块。

-c config-file, --config-file=config-file

使用 config-file 而不是默认的 ~/.viewdoc

-l, --list-styles

列出可用样式并退出。

-h, --help

打印帮助信息并退出。

-v, --version

打印版本字符串并退出。

--no-color

禁用输出颜色。

--no-browser

将HTML打印到标准输出。

参数

rst文件

要查看的reST文件。

egg目录

要查看其长描述的Python包。默认为当前工作目录。

配置

viewdoc从其配置文件~/.viewdoc中读取样式信息。编辑此文件以添加您自己的样式。

内置样式

plain

浏览器默认样式,带有边距。

pypi

带有Google Fonts的新PyPI样式。

sans

无Google Fonts的PyPI样式(默认)。

变更日志

2.7 - 2023-09-23

  • 更新tox.ini以使用最新版本的tox。[stefan]

  • 过滤已弃用的配置警告。[stefan]

  • 修复无效的转义序列。[stefan]

  • 修复docutils >= 0.20.0的测试。[stefan]

2.6 - 2023-01-21

  • 支持setuptools >= 65.6.0。[stefan]

2.5 - 2022-11-13

  • 支持Python 2.7 - 3.11。[stefan]

  • 如果存在pyproject.toml,则不需要setup.py或setup.cfg。[stefan]

  • 过滤一些弃用警告。[stefan]

  • 如果缺少长描述元数据,则发出警告。[stefan]

2.4 - 2022-02-26

  • 支持Python 2.7 - 3.10。[stefan]

  • 修复样式中的代码块背景颜色。[stefan]

  • 样式下保留链接的下划线。[stefan]

  • 添加输出颜色。[stefan]

  • 如果存在setup.cfg,则不需要setup.py。[stefan]

  • 将元数据移动到setup.cfg。[stefan]

  • 将测试从jarn.viewdoc命名空间中移出。[stefan]

  • 在sdist中包含测试,但在wheel中不包含。[stefan]

2.3 - 2019-01-28

  • 支持python -m jarn.viewdoc。[stefan]

2.2 - 2019-01-25

  • 放弃对Python 2.6的支持,添加Python 3.7。[stefan]

  • 根据新的PyPI(仓库)更新样式。[stefan]

  • 默认为sans样式,因为新的PyPI使用Google Fonts。[stefan]

  • 在配置解析器选项xform中将破折号转换为下划线。[stefan]

2.1 - 2017-10-06

  • 添加MANIFEST.in。[stefan]

2.0 - 2017-07-20

  • 更新样式表(灰色代码块)。[stefan]

  • 自动升级样式表信息。[stefan]

  • 添加-b选项以指定要使用的浏览器。[stefan]

  • 防止不良或不完整的区域设置。[stefan]

1.8 - 2017-01-30

  • 支持Python 2.6 - 3.6,无需2to3。[stefan]

1.7 - 2014-03-22

  • 面对新的python.org更新PyPI样式表链接。[stefan]

  • 添加新的样式,并将以前的样式重命名为。[stefan]

1.6 - 2013-11-21

  • 支持Python 3.x。[stefan]

1.5 - 2012-07-11

  • 恢复Python 2.5兼容性。[stefan]

1.4 - 2011-11-25

  • 如果~/.viewdoc有错误,则发出警告而不是抛出异常。[stefan]

1.3 - 2011-10-31

  • 对我们放在PYTHONPATH上的内容更加小心。[stefan]

  • small样式添加到默认配置。[stefan]

1.2 - 2011-07-19

  • 将PYTHONPATH传递给子进程。[stefan]

  • 在提取长描述时避免使用临时文件。[stefan]

  • 添加-l选项以列出可用的样式。[stefan]

  • 添加-s style的快捷方式为–style。[stefan]

1.1 - 2011-02-08

  • 添加-s选项以在命令行上选择样式。[stefan]

  • 样式中,仅下划线引用链接。[stefan]

1.0 - 2010-12-30

  • 首次发布 [stefan]

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

jarn.viewdoc-2.7.tar.gz (15.7 kB 查看哈希值)

上传时间 源代码

构建分发

jarn.viewdoc-2.7-py2.py3-none-any.whl (14.1 kB 查看哈希值)

上传时间 Python 2 Python 3