ReStructuredText查看器
项目描述
ReStructuredText文档查看器，可以实时渲染文档。
将ReStructuredText文档的名称传递给restview，它将在localhost:random-port上启动一个Web服务器并打开一个网络浏览器。每次您重新加载页面时，restview都会从磁盘重新加载文档并渲染它。这在编辑文档时预览文档非常方便。
您还可以传递一个目录的名称，restview将递归地查找以.txt或.rst结尾的文件，并显示一个列表。
最后，您可以通过使用以下方式确保您的Python包在long_description字段中具有有效的ReStructuredText
restview --long-description
概述
用法： restview [选项] filename-or-directory [...]
- -h，--help
显示此帮助信息并退出
- --version
显示程序版本号并退出
- -l PORT，--listen=PORT
监听指定的端口（或接口：端口，例如 *:8080）[默认：localhost上的随机端口]
- --allowed-hosts HOSTS
允许的Host头值（默认：仅允许localhost，除非指定-l *:port，此时默认接受任何Host:）
- -b，--browser
打开网页浏览器[默认：如果没有指定-l时才打开]
- -B，--no-browser
不打开网页浏览器
- -e COMMAND，--execute=COMMAND
运行命令以在标准输出产生ReStructuredText
- -w FILENAME，--watch=FILENAME
当文件更改时重新加载页面（与–execute一起使用）；可以多次指定
- --long-description
运行“python setup.py –long-description”以产生ReStructuredText；同时启用–pypi-strict并监视常规的长描述源（setup.py、README.rst、CHANGES.rst）
- --css=URL-or-FILENAME
使用指定的样式表；可以多次指定[默认：html4css1.css,restview.css]
- --report-level REPORT_LEVEL
设置docutils的“report_level”选项；restview将在此级别或以上报告系统消息（1=信息，2=警告，3=错误，4=严重）
- --halt-level HALT_LEVEL
设置docutils的“halt_level”选项；当记录到此级别或以上的系统消息时（1=信息，2=警告，3=错误，4=严重），restview将停止处理文档
- --strict
在出现任何问题时停止；相当于–halt-level=2
- --pypi-strict
启用PyPI执行的附加限制
安装
基于.deb的系统（例如Ubuntu）
sudo apt-get install python-pip sudo pip install restview
基于.rpm的系统（例如Fedora）
su yum install python-pip pip install restview
变更日志
3.0.1 (2023-01-10)
增加对Python 3.11的支持。
停止支持Python 3.6。
将readme-renderer限制在 < 37.0，因为它切换到了不同的docutils writer（html5_polyglot而不是html4css1），这会导致问题（问题65）。这将在新版本中得到妥善解决。
3.0.0 (2022-01-12)
停止支持Python 2.7。
2.9.3 (2021-11-29)
修复了由Sébastien Besson贡献的docutils 0.18.1的不兼容性，导致“无法嵌入样式表”错误（问题61）。
增加对Python 3.8、3.9和3.10的支持。
停止支持Python 3.5。
2.9.2 (2019-04-23)
声明支持Python 3.7。
停止支持Python 3.4。
2.9.1 (2018-05-18)
忽略成功产生标准输出（如setup.py –long-description打印的警告）的外部命令的stderr。修复了#55。
处理readme_renderer.clean.clean()在失败时返回None的情况。
2.9.0 (2018-05-03)
添加了__main__.py模块，允许使用python -m restview执行包。- SimplyKnownAsG
2.8.1 (2018-01-28)
防止DNS重绑定攻击。参见#51。
2.8.0 (2017-12-07)
2.7.0 (2016-09-15)
2.6.1 (2016-01-05)
2.6.0 (2015-12-31)
实现 restview --version （问题 #37）。
在渲染失败时突出显示错误的源行，例如在 --strict 模式下（问题 #40）。
2.5.2 (2015-11-20)
为 SVG 图像使用正确的 MIME 类型（问题 #36）。
2.5.1 (2015-11-17)
支持 SVG 图像（问题 #36）。
2.5.0 (2015-10-27)
修复在 –pypi-strict 模式下的 HTML 清洗代码（问题 #33）。
停止支持 Python 2.6。
声明支持 Python 3.5。
2.4.0 (2015-05-27)
停止支持 Python 3.2。
在 setup.py 中停止动态计算 install_requires，这在 pip 7 轮缓存存在的情况下工作得不好。
2.3.0 (2015-01-26)
遵循 PyPI 的做法，在 –pypi-strict 模式下依赖 readme 进行渲染。修复问题 #28。
2.2.1 (2015-01-06)
修复自动重新加载时的样式丢失。修复问题 #25。
2.2.0 (2014-12-10)
使用 AJAX 重新加载页面以保留滚动位置。修复问题 #22。
使用默认的 docutils CSS 而不是完全替换它。删除一些我们的样式，包括
左对齐的文档标题
文档文本的无衬线字体覆盖
全对齐的文本
定义列表中的粗体术语
仅使用水平线的自定义表格渲染（问题 #23）
保留其他自定义样式覆盖
自定义脚注渲染（我真的很喜欢它）
代码块背景为白色
更漂亮的系统错误消息
统一对齐代码块、块引用和 doctests
修复问题 #23。
--css 选项可以多次提供，并且可以引用标准样式表（由 docutils 和 restview 提供的样式表）而无需指定完整路径。
例如，如果您想回到 2.2.0 版本之前 restview 使用的样式，可以使用
restview --css oldrestview.css ...
如果您想在标准 docutils 样式之上添加自己的自定义样式，请使用
restview --css html4css1.css --css ./path/to/my.css
如果您想完全覆盖样式表，请使用
restview --css ./path/to/my.css
新选项：--watch。在给定文件更改时重新加载页面。主要用于与 -e 一起使用，但在开发 CSS 时也可能很有用。可以多次指定，例如
restview --css my.css -e 'cat one.rst two.rst' -w my.css -w one.rst -w two.rst
restview --long-description 监视 setup.py、README.rst 和 CHANGES.rst 的更新，并自动重新加载描述。
如果源文件更改，错误页面也会自动重新加载。
在严格模式下，错误页面将提到文件名而不是 <string>。
文件监控现在关注小数秒。
2.1.1 (2014-09-28)
修复在 Python 3 上报告 ReST 错误时的 TypeError（通常在严格模式下）。修复问题 #21。
修复在 Python 3 上使用 --pypi-strict 时的 TypeError。
2.1.0 (2014-09-02)
--pypi-strict 模式以捕获在 Python 包索引上破坏渲染的额外问题。–long-description 自动启用此功能。修复问题 #18。
将安装部分添加到 README 中。修复问题 #19。
2.0.5 (2014-06-09)
避免在 ReStructuredText 文件编码与区域设置不匹配时在 Python 3 上出现 Unicode 错误。修复问题 #16。
在Python 3中，当文件名使用与本地不匹配的编码时，避免Unicode错误。修复了https://github.com/mgedmin/restview/issues/17。
2.0.4 (2014-04-28)
当外部命令失败时，显示清晰的错误信息。修复了https://github.com/mgedmin/restview/issues/14。
停止篡改文档标题。修复了https://github.com/mgedmin/restview/issues/15。
2.0.3 (2014-02-01)
使用更大的字体区分文档标题与章节标题。修复了https://github.com/mgedmin/restview/issues/12。
对restview在Windows上的表现进行了一些小的调整和修复（例如，所有测试现在都通过）。
2.0.2 (2013-10-02)
当restview正在轮询更改时文件消失时，抑制错误。修复了https://github.com/mgedmin/restview/issues/11。
添加了favicon。修复了https://github.com/mgedmin/restview/issues/8。
2.0.1 (2013-05-01)
始终要求Pygments。修复了https://github.com/mgedmin/restview/issues/9。
2.0 (2013-04-04)
Python 3支持（LP#1093098）。由Steven Myint修补（git@stevenmyint.com）。
迁移到Github。
100%测试覆盖率。
当源文件更改时，自动重新加载网页（LP#965746）。由speq修补（sp@bsdx.org），经Eric Knibbe和Marius Gedminas修改。
新选项：restview –long-description（显示python setup.py –long-description的输出）。
新选项：restview –strict。由Steven Myint修补（git@stevenmyint.com）。
改进本地文件名的自动链接。
允许子目录。
识别.rst扩展名。
Eric Knibbe做出了许多改进。
restview dirname现在忽略隐藏子目录。
目录列表中的文件按不区分大小写的方式排序。
允许服务gif和jpg图像。
为标题、侧边栏等许多其他事物添加CSS规则。
为代码块添加语法高亮。
改进HTTP错误信息。
添加HTTP头以防止浏览器缓存动态内容。
1.2.2 (2010-09-14)
setup.py不再需要docutils（LP#637423）。
1.2.1 (2010-09-12)
处理URL中的空格和其他特殊字符（LP#616335）。
不要将外部引用中的文件名链接化（LP#634827）。
1.2 (2010-08-06)
“严重”的docutils错误现在在浏览器中显示一条消息和未格式化的文件，而不是控制台上的堆栈跟踪。
添加了新的命令行选项，-e COMMAND。
添加了警告的样式；许多其他重要样式仍然缺失。
1.1.3 (2009-10-25)
在setup.py中正确拼写‘extras_require’（LP#459840）。
添加MANIFEST.in以完整源代码分发（LP#459845）。
1.1.2 (2009-10-14)
修复Mac OS X上“localhost”名称解析错误。
1.1.1 (2009-07-13)
在后台启动Web服务器。
1.1.0 (2008-08-26)
接受命令行上的任意数量的文件和目录。
1.0.1 (2008-07-26)
新选项：–css。接受一个文件名或HTTP/HTTPS URL。
1.0.0 (2008-07-26)
提高版本号以反映稳定性。
小的CSS调整。
0.0.5 (2007-09-29)
创建到其他按名称引用的本地文件的链接。
使用pygments（如果可用）为doctest块进行语法高亮。
处理JPEG图像。
0.0.4 (2007-09-28)
移除不稳定的Gtk+版本。
0.0.3 (2007-09-28)
使用setuptools进行打包。
0.0.2 (2007-01-21)
基于浏览器的版本。
命令行选项-l, -b（感谢Charlie Shepherd）。
CSS调整。
Unicode修复。
可以浏览目录树。
可以服务图像。
0.0.1 (2005-12-06)
带有GtkMozEmbed的PyGtk+版本。不太稳定。
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。