我计划使用reStructuredText来编写文档,主要目的是生成一些漂亮的HTML页面。为此,我使用 docutils rst2html.py 工具。
但是,我可能还需要以良好的纯文本格式呈现文档,即没有 reStructuredText 标记,并且仍然在文本输出上执行段落换行和类似的良好格式设置。但是,文档中没有 rst2txt.py 工具。
有没有办法将 reStructuredText 转换为漂亮的纯文本格式,也许可以使用 docutils 的特殊选项?
我还看到通过使用 rst2html 渲染为 html,然后使用命令行 html 浏览器将 html 转换为纯文本来完成此操作,例如:
每个浏览器都有一个命令行开关或类似的命令来将其输出渲染到 .txt 文件,因此您可以创建一个名为“rst2txt”的两行脚本,如下所示:
rst2html docs.rst docs.html
lynx -dump docs.html > docs.txt
Sphinx 有一个 TextBuilder 用于 txt 输出格式。刚刚尝试了一下,它似乎满足了您的要求。
但是,它可能有点过时,因为它不在默认的 Makefile 中。但它在我相当复杂的文档(150 个 pdf 页)上效果很好。要使用它,只需添加以下目标即可:
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
@echo
@echo "Build finished."
另外,请记住 Sphinx 仅实现第一个规范的子集。