使用源代码

除了支持 reStructuredText Docstring Format (PEP 287)之外,PyCharm 还为重组文本提供了一个方便的编辑器。

与Markdown 编辑器类似,您可以修改 reStructuredText 文件并在Preview面板中验证结果。您可以使用相应的图标在可用的编辑模式之间切换。编辑和预览模式反映了当前选择的 PyCharm用户界面外观

仅编辑器模式
编辑器和预览模式
仅预览模式

您可以使用重组后的文本打开任何现有文件,也可以从头开始创建新文件。

创建一个 .rst 文件

  1. 在Project工具窗口中右击并选择New | 文件. 在打开的对话框中,指定任何带有.rst扩展名的文件名,然后单击OK

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

    具有重组文本的文件
  3. 新创建的文件将在编辑器窗口中打开。未添加文本时,预览将被禁用。

让我们添加一些内容,看看 PyCharm 如何协助编辑重组文本。

编辑文本

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

    为 reStructuredText 设置配色方案

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

  2. 添加任何部分结构标记并切换到拆分视图模式以预览结果。请注意,PyCharm 支持标记检查,因此如果检测到任何错误,有问题的行会在编辑器面板中突出显示,并且相应的错误消息会显示在预览面板中。

    检测到标记错误
  3. 使用.. code-block::指令添加代码片段。PyCharm 支持指令名称的代码完成。

    指令名称的代码完成

    您可以通过在指令中指定特定语言来启用代码语法突出显示:.. code-block:: python。此外,确保您的项目解释器安装了Pygments包。

    在代码块中突出显示 Python 语法
  4. 如果需要,您可以快速标记文本中的链接并推迟添加参考目标。PyCharm 会通知您并突出显示缺少引用的链接。

    缺少参考目标的链接

    您只需将正确的目标引用添加到 reStructuredText 文件,例如.. _pytest: https://docs.pytest.org/

    有效链接

如果您在预览内容时遇到任何问题,请尝试更改“预览”面板的类型。在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,导航到Languages & Frameworks | ReStructured Text ,然后从Preview 面板列表中选择SwingJCEF ,单击OK,然后继续编辑.rst文件。

最后修改:2022 年 1 月 14 日