在vim中突出显示python doc字符串中的ReST

Posted 2023-02-22

【中文标题】在vim中突出显示python doc字符串中的ReST

【英文标题】：Highlighting ReST in python doc strings within vim

【发布时间】：2014-08-20 00:33:02

【问题描述】：

由于我将 Sphinx 与 autodoc 一起使用，我想让我的 vim 使用 ReST 语法突出显示 python 文档字符串。这可能吗？

用谷歌搜索只得到一个可用的结果（但我很惊讶没有找到更多）：http://www.liafa.univ-paris-diderot.fr/~labbe/blogue/2011/06/rest-syntax-highlighting-for-sage-docstrings-in-vim/ 但是这个解决方案似乎有一些循环依赖，这导致我的 vim 抱怨无限的错误消息......不知道如何解决这个问题：/

在 *** 上我找到了这个： Vim syntax highlighting of doxygen style docstrings in Python 但我也不知道如何适应。

有什么建议吗？ 在此先感谢:)

【问题讨论】：

最后我找到了 riv.vim 和 let g:riv_python_rst_hl=1 的插件，它可以满足我的需求。

您应该将该评论作为答案发布

我试过了，太短的答案会自动转换成cmets...

填写一下？描述 riv.vim 是什么，该选项有什么作用，以及它有什么缺陷......

【参考方案1】：

正如 cmets 中提到的，有一个 vim 插件riv.vim，它提供了许多与 reST 文档交互的工具。如果你这样做：

let g:riv_python_rst_hl=1

它将为 python 文件中的文档字符串启用正确的 reST 语法高亮。

【讨论】：

这个插件不适合我。我的 python 文件中的文档字符串没有改变。