蟒蛇文献目录
jarn.viewdoc的Python项目详细描述
viewdoc是一个Python包文档查看器它改变了 将reST格式的文本转换为HTML并在浏览器窗口中显示
viewdoc通常用于在 上传到pypi。
安装
viewdoc与python 2.7-3.7以及setuptools的所有发布版本一起工作 然后分发。
使用pip install jarn.viewdoc安装viewdoc脚本。
用法
viewdoc [options] [rst-file | egg-dir]
选项
- -s style, --style=style, or --style
- 选择添加到HTML输出的自定义样式。
- -b browser, --browser=browser
- 选择用于显示的浏览器。有关名称列表，请参见 webbrowser模块。
- -cconfig-file,--config-file=config-file
- 使用配置文件而不是默认的~/.viewdoc。
- -l,--list-styles 列出可用的样式并退出。
- -h,--help
- 打印帮助消息并退出.< /dD>
- -v,--version
- 打印版本字符串并退出.< /dD>
- rst-file
- 要查看的其余文件。
- egg-dir
- 要查看其详细描述的python包。 默认为当前工作目录。
配置
viewdoc从其配置文件中读取样式信息 ~/.viewdoc。编辑此文件以添加您自己的样式。
内置样式
- plain
- 浏览器默认页边距。
- pypi
- 使用google字体的新pypi样式。
- sans
- 不带google字体的类似pypi的样式（默认值）。
已知错误
如果你在马科斯山，请注意https://bugs.python.org/issue30392。作为 解决方法在命令行中指定浏览器：
$ viewdoc -b safari src/my.package
或者使用配置文件：
[viewdoc] browser = safari
更改日志
2.3-2019年1月28日
- 支持python -m jarn.viewdoc。 [斯特凡]
2.2-2019-01-25
- 放弃Python2.6支持，添加Python3.7。 [斯特凡]
- 根据新的PyPI（仓库）更新样式。 [斯特凡]
- 默认为sans样式，因为新的pypi使用google字体。 [斯特凡]
- 在配置分析器optionxform中将破折号转换为下划线。 [斯特凡]
2.1-2017-10-06
- 添加manifest.in。 [斯特凡]
2.0-2017年7月20日
- 更新pypi样式表（灰色代码块）。 [斯特凡]
- 自动升级样式表信息。 [斯特凡]
- 添加-b选项以指定要使用的浏览器。 [斯特凡]
- 防止错误或不完整的区域设置。 [斯特凡]
1.8-2017-01-30
- 支持Python2.6-3.6，不支持2to3。 [斯特凡]
1.7-2014年3月22日
- 面对新的python.org更新PyPI样式表链接。 [斯特凡]
- 添加新的pypi样式，并将前一个样式重命名为classic。 [斯特凡]
1.6-2013年11月21日
- 支持Python3.x。 [斯特凡]
1.5-2012年7月11日
- 恢复Python2.5的兼容性。 [斯特凡]
1.4-2011年11月25日
- 如果~/.viewdoc有错误而不是引发异常，则发出警告。 [斯特凡]
1.3-2011年10月31日
- 我们在Python身上穿什么要小心点。 [斯特凡]
- 将small样式添加到默认配置。 [斯特凡]
1.2-2011年7月19日
- 将PYTHONPATH传递给子进程。 [斯特凡]
- 提取长描述时避免使用临时文件。 [斯特凡]
- 添加-l选项以列出可用的样式。 [斯特凡]
- 为-sstyle添加–style快捷方式。 [斯特凡]
1.1-2011-02-08
- 加法运算在命令行上选择样式。 [斯特凡]
- 在pypi样式中，只给引用链接加下划线。 [斯特凡]
1.0-2010年12月30日
- 初次发行 [斯特凡]
欢迎加入QQ群-->： 979659372
