You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

pyproject.toml配置README.rst为long_description失败,语法报错求助

解决README.rst作为long_description在pyproject.toml中失效的问题
  • 修复空README.rst的语法错误:空的RST文件不符合PyPI渲染器的格式要求,会被判定为语法错误。至少给文件添加基础内容,比如:

    项目名称
    ========
    
    这里是项目的详细描述。
    
  • 补充long_description_content_type配置:在pyproject.toml的[project]区块中添加该字段,解决tar.gz包的警告:

    [project]
    # 保留已有配置...
    readme = "README.rst"
    long_description_content_type = "text/x-rst"
    
  • 兼容旧版构建工具(可选):部分老旧build后端可能不支持readme字段,可同时显式配置long_description:

    [project]
    # 保留已有配置...
    long_description = file: README.rst
    long_description_content_type = "text/x-rst"
    
  • 本地验证RST语法:如果仍报语法错误,安装docutils后本地验证:

    pip install docutils
    rst2html.py README.rst > test.html
    

    打开test.html检查是否有渲染异常,排查RST格式问题。

内容的提问来源于stack exchange,提问作者user1255603

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.09 19:31:15