PyCharm 2025.2 Help

reStructuredText 支持

除了支持 reStructuredText Docstring 格式 (PEP 287) 外,PyCharm 还提供了一个用于编辑 restructured text 的编辑器。

Markdown 编辑器 类似,您可以修改 reStructuredText 文件并在预览面板中验证结果。

编辑器和预览模式

您可以打开任何包含 restructured text 的现有文件,或从头创建一个新文件。

创建一个 .rst 文件

  1. 项目 工具窗口中右键点击并选择 新建(N) | 文件(F)。 在打开的对话框中,指定一个带有 .rst 扩展名的文件名,然后点击 确定

  2. PyCharm 会识别文件类型并用相应的图标标记。

    包含重构文本的文件
  3. 新创建的文件将在编辑器中打开。

让我们添加一些内容,看看 PyCharm 如何协助编辑 restructured text。

编辑文本

  1. 设置 对话框(Ctrl+Alt+S )中,查看 reStructuredText 的默认配色方案(编辑器 | 配色方案 | reStructuredText)。 如果需要,为标记元素设置替代颜色和效果。

    为 reStructuredText 设置配色方案

    点击 确定 保存更改并关闭窗口。

  2. 添加任何章节结构标记并预览结果。

  3. 通过使用 .. 代码块:: 指令添加代码片段。 PyCharm 支持指令名称的代码补全。

    指令名称的代码补全

    您可以通过在指令中指定特定语言来启用代码语法高亮: .. 代码块:: python 。 此外,请确保您的项目解释器已安装 Pygments installed

    在代码块中高亮显示 Python 语法
  4. 您可以快速在文本中标记链接,并延后添加引用目标。 PyCharm 会通知您并高亮显示缺少引用的链接。

    您只需为 reStructuredText 文件添加适当的目标引用,例如 .. _pytest:https://docs.pytest.org/ _pytest: https://docs.pytest.org/

    有效链接
最后修改日期: 2025年 9月 26日