如何将 reStructuredText 转换为纯文本
我计划使用 reStructuredText 来编写文档,主要目的是生成一些漂亮的 HTML 页面。 为此,我使用 docutils rst2html.py 工具。
但是,我可能还需要以良好的纯文本格式呈现文档,即没有 reStructuredText 标记,并且仍然在文本输出上执行段落换行和类似的良好格式设置。 但是,文档中没有 rst2txt.py 工具。
有没有办法将 reStructuredText 转换为漂亮的纯文本格式,也许可以使用 docutils 的特殊选项?
I plan to use reStructuredText to write documentation with the main purpose of generating some nice HTML pages. For this I use the docutils rst2html.py tool.
However, I may also need to present the documentation in nice plain text format, that is without the reStructuredText markup, and where paragraph wrapping and similar nice formatting is still performed on the text output. But, there is no rst2txt.py tool in the docutils.
Is there a way to convert reStructuredText to nice plain text format, maybe with use of special options to docutils ?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
我还看到过使用 rst2html 渲染为 html,然后使用命令行 html 浏览器将 html 转换为纯文本,例如:
这些浏览器中的每一个都有一个命令行开关或类似的命令来将其输出呈现到 .txt 文件,因此您可以创建两个名为“rst2txt”的行脚本,如下所示:
I have also seen this done by rendering to html using rst2html, then converting the html to plain text by using a command-line html browser, such as:
Each of these browsers has a command-line switch or similar to render its output to a .txt file, so you could create a two line script called 'rst2txt', something like:
Sphinx 有一个用于 txt 输出格式的 TextBuilder。 刚刚尝试了一下,它似乎可以满足您的要求。
但是,它可能有点过时,因为它不在默认 Makefile 中。 但它在我相当复杂的文档(150 个 pdf 页)上效果很好。 要使用它,只需向其中添加以下目标:
另外,请记住 Sphinx 仅实现第一个规范的子集。
Sphinx has a TextBuilder for txt output format. Just tried it and it seems to do what you are looking for.
However, it might be a little outdated because it is not in the default Makefile. But it worked well on my fairly complex documentation (150 pdf pages). To use it, just add the following target to it:
Also, keep in mind that Sphinx implements only a subset of the rst specs.