知识卡片
说明格式要随元数据显式声明
项目说明应在仓库页面上正确渲染,保持源码README与发布说明一致可减少维护。原书称PyPI只支持reStructuredText已过时:当前项目元数据可声明Markdown README。其pypandoc转换和回退只是旧环境策略;只捕获ImportError也不覆盖转换程序缺失或执行失败,不能宣称这段代码确保所有安装都成功。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第5章 编写一个包 5.1.2 项目配置 · 查看原书依据
目前PyPI上的文档标记只能使用reStructuredText
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第5章 编写一个包,spine014单元005;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00013.html。
- 结论依据:原文试图让README与发布说明一致,支持维护动机;只支持reStructuredText属旧版限制,Markdown声明按已核对元数据规则说明。补充核验入口:https://packaging.python.org/en/latest/guides/writing-pyproject-toml/。未在本机运行示例或改变环境。
- 原始内容:在上传时会转换为HTML格式。不幸的是,目前PyPI上的文档标记只能使用reStructuredText。这在短期内也不太可能改变。更有可能的是,如果 warehouse 项目完全取代了当前的PyPI实现,那么将会支持其他标记语言。不幸的是,我们仍然不知道 warehous