Python reStructuredText 帮助文件中文乱码

在使用 IntelliJ 对 reStructuredText 文件进行编辑的时候。

我们可能会遇到乱码的情况。

如下图:

python-encode-01

可以看到,我们在使用 IntelliJ 的时候中文是乱码的。

这里有几个地方是需要修改的,首先你需要修改你的项目使用的是 UTF-8 编码。

Ctrl + Alt + S 进入设置,然后选择 Editor > File Encodings

你需要将你的全局设置,项目编码都设置成 UTF-8,如果你使用的是中文操作系统,可能这里默认设置是 GBK,不要使用 GBK。

python-encode-02

然后重启你的 IntelliJ, 你可能会发现你的修改没有生效。

这是因为 reStructuredText 的插件使用了 Java 的 JavaFX 或者 Swing,这在默认情况下是不支持 UTF-8 的。

你需要对 IntelliJ 的启动参数进行设置。

选择帮助下面的修改自定 VM 选项。

python-encode-03

在文件的最后添加

-Dfile.encoding=UTF-8

这个表示的是在 IntelliJ 启动的时候,我们将 VM 的启动参数强制使用 UTF-8 编码。

python-encode-04

在完成上面的修改后,重启你的 IntelliJ,然后在对文件进行对比查看。

你可以看到你的 IntelliJ 已经能够支持中文了。

python-encode-05

因为你 IntelliJ 是基于 Java 平台,Java 平台中的 JavaFX 和 Swing 对 UTF-8 的支持一种不是非常理想,不是开箱即用的那种。

 

https://www.ossez.com/t/python-restructuredtext/179

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Python自带的文档生成库是sphinx。sphinx可以通过编写reStructuredText格式的文档,生成美观的HTML文档、PDF文档、EPUB文档等多种格式。sphinx常用于生成Python程序的API文档、项目文档等。 以下是一个简单的例子,展示如何使用sphinx生成文档。假设我们有一个名为“myproject”的Python项目,其中包含一个名为“mymodule”的模块。我们可以按照如下步骤进行文档生成: 1. 安装sphinx库:在命令行中执行“pip install sphinx”。 2. 在“myproject”目录下创建一个“docs”子目录,并进入该目录。 3. 初始化sphinx:在命令行中执行“sphinx-quickstart”,根据提示设置sphinx的一些选项。 4. 配置sphinx:在“docs/conf.py”文件中,添加以下内容: ``` import os import sys sys.path.insert(0, os.path.abspath('../')) ``` 这段代码的作用是将“myproject”目录添加到Python搜索路径中,以便让sphinx找到“mymodule”。 5. 编写文档:在“docs/source”目录下,创建一个“index.rst文件,并添加以下内容: ``` .. toctree:: :maxdepth: 2 :caption: Contents: mymodule ``` 这段代码的作用是创建一个文档目录,并将“mymodule”模块添加到目录中。 6. 编写模块文档:在“docs/source”目录下,创建一个“mymodule.rst文件,并添加以下内容: ``` .. automodule:: mymodule :members: :undoc-members: ``` 这段代码的作用是自动提取“mymodule”模块中的成员,并生成文档。 7. 生成文档:在命令行中执行“make html”,sphinx会自动编译文档,并生成“_build/html”目录下的HTML文件

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

HoneyMoose

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值