重构文本查看器
项目描述
ReStructuredText 文档的查看器，可即时呈现它们。
将 ReStructuredText 文档的名称传递给restview，它将在 localhost:random-port 上启动一个 Web 服务器并打开一个 Web 浏览器。每次重新加载页面时，restview 都会从磁盘重新加载文档并进行渲染。这对于在编辑文档时预览文档非常方便。
您还可以传递目录的名称，restview 将递归查找以 .txt 或 .rst 结尾的文件并为您提供一个列表。
最后，您可以通过使用确保您的 Python 包在 long_description 字段中具有有效的 ReStructuredText
restview --long-description
概要
用法：restview [选项]文件名或目录 [...]
- -h, --help
显示此帮助信息并退出
- --version
显示程序的版本号并退出
- -l PORT, --listen=PORT
侦听给定端口（或接口：端口，例如 *:8080）[默认值：本地主机上的随机端口]
- --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.0 (2022-01-12)
放弃对 Python 2.7 的支持。
2.9.3 (2021-11-29)
修复与 docutils 0.18.1 的不兼容导致“无法嵌入样式表”错误（问题 61，由 Sébastien Besson 提供）。
添加对 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 打印的警告）。修复#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)
2.5.2 (2015-11-20)
为 SVG 图像使用正确的内容类型 ( #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 模式下进行渲染。修复https://github.com/mgedmin/restview/issues/28。
2.2.1 (2015-01-06)
修复自动重新加载时的样式丢失。修复https://github.com/mgedmin/restview/issues/25。
2.2.0 (2014-12-10)
使用 AJAX 重新加载页面以保留滚动位置。修复https://github.com/mgedmin/restview/issues/22。
使用默认的 docutils CSS 而不是批发替换它。删除我们的一些样式，包括：
左对齐文档标题
文档文本的无衬线字体覆盖
完全对齐的文本
定义列表中的粗体术语
仅使用水平规则的自定义表格渲染（问题 #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)
在报告 ReST 错误（通常在严格模式下）时修复 Python 3 上的 TypeError。修复https://github.com/mgedmin/restview/issues/21。
使用--pypi-strict时修复 Python 3 上的 TypeError 。
2.1.0 (2014-09-02)
--pypi-strict模式以捕获破坏 Python Packaging Index 渲染的其他问题。 --long-description自动启用此功能。修复https://github.com/mgedmin/restview/issues/18。
在自述文件中添加了安装部分。修复https://github.com/mgedmin/restview/issues/19。
2.0.5 (2014-06-09)
当 ReStructuredText 文件的编码与区域设置不匹配时，避免 Python 3 上的 Unicode 错误。修复https://github.com/mgedmin/restview/issues/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。
添加了一个网站图标。修复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 (LP#459840) 中正确拼写“extras_require”。
添加 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+ 版本。不是很稳定。
