What format for a Python package's README on github?

W.P. McNeill

The Python distutils in setup.py looks for README and README.txt in the root directory of a package. github recognizes formats like README.md and README.rst. How do I write one formatted root level README file that satisfies both?

The only suggestion I've seen up here is to run Pandoc to covert between the formats. I'd like to avoid adding an extra build step if possible.

Is there some way to tell distutils "Use my README.rst"?

Alternately, are there any bad repercussions of ignoring this warning when I run python setup.py sdist?

warning: sdist: standard file not found: should have one of README, README.txt

PS. I'm using distutils.core because Google leads me here. Is that out of date?

W.P. McNeill

Looks like the answer is to use setuptools instead of distutils.core. If you follow the setuptools instructions you can see how to make your default README an .rst file.

本文收集自互联网,转载请注明来源。

如有侵权,请联系[email protected] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

github上Python软件包的README的格式是什么?

来自分类Dev

Python文档字符串到GitHub README.md

来自分类Dev

github上Python包的README的格式是什么?

来自分类Dev

GitHub README不在AWS S3上显示外部映像

来自分类Dev

将Bookmarklet嵌入GitHub README.md

来自分类Dev

将JavaScript嵌入GitHub README.md

来自分类常见问题

github从README链接到Wiki页面

来自分类Dev

Github readme.md对齐图像

来自分类Dev

github的README.md中注释的语法?

来自分类Dev

Github README 突然无法正常显示

来自分类Dev

Github在README.md中包含md文件?

来自分类Dev

如何向Github README.md添加背景图像

来自分类Dev

在github的README.adoc中使用“外部”属性

来自分类Dev

使README.adoc(AsciiDoc)在GitHub上居中对齐图像

来自分类Dev

无法登录GitHub Package Registry

来自分类Dev

what's Python asyncio.Lock() for?

来自分类Dev

如何在GitHub上的README.rst中强制更新图像(缓存)

来自分类Dev

您如何使用GitHub风格的markdown在README文件中缩进项目符号列表?

来自分类Dev

Markdown语法,用于在Github上的README.md中突出显示语法

来自分类Dev

GitHub显示README.rmd中的所有代码块(尽管include = FALSE)

来自分类Dev

如何在GitHub上使用markdown将原始HTML粘贴到README.md中?

来自分类Dev

扬声器甲板幻灯片可以嵌入github的README文件中吗?

来自分类Dev

在README.md之类的github在线目录中显示license.md

来自分类Dev

如何在GitHub(readme.md)上发布OpenAPI文档的最佳方法?

来自分类Dev

如何显示KaTex-GitHub README.md文件上的输出?

来自分类Dev

如何将嵌入的动画gif添加到github存储库README.md?

来自分类Dev

如何在Github的配置文件中显示readme.md文件?

来自分类Dev

如何在Github的README上添加R-CMD检查状态

来自分类Dev

如何将彩色文本放入github的README.md或Index.md文件

Related 相关文章

  1. 1

    github上Python软件包的README的格式是什么?

  2. 2

    Python文档字符串到GitHub README.md

  3. 3

    github上Python包的README的格式是什么?

  4. 4

    GitHub README不在AWS S3上显示外部映像

  5. 5

    将Bookmarklet嵌入GitHub README.md

  6. 6

    将JavaScript嵌入GitHub README.md

  7. 7

    github从README链接到Wiki页面

  8. 8

    Github readme.md对齐图像

  9. 9

    github的README.md中注释的语法?

  10. 10

    Github README 突然无法正常显示

  11. 11

    Github在README.md中包含md文件?

  12. 12

    如何向Github README.md添加背景图像

  13. 13

    在github的README.adoc中使用“外部”属性

  14. 14

    使README.adoc(AsciiDoc)在GitHub上居中对齐图像

  15. 15

    无法登录GitHub Package Registry

  16. 16

    what's Python asyncio.Lock() for?

  17. 17

    如何在GitHub上的README.rst中强制更新图像(缓存)

  18. 18

    您如何使用GitHub风格的markdown在README文件中缩进项目符号列表?

  19. 19

    Markdown语法,用于在Github上的README.md中突出显示语法

  20. 20

    GitHub显示README.rmd中的所有代码块(尽管include = FALSE)

  21. 21

    如何在GitHub上使用markdown将原始HTML粘贴到README.md中?

  22. 22

    扬声器甲板幻灯片可以嵌入github的README文件中吗?

  23. 23

    在README.md之类的github在线目录中显示license.md

  24. 24

    如何在GitHub(readme.md)上发布OpenAPI文档的最佳方法?

  25. 25

    如何显示KaTex-GitHub README.md文件上的输出?

  26. 26

    如何将嵌入的动画gif添加到github存储库README.md?

  27. 27

    如何在Github的配置文件中显示readme.md文件?

  28. 28

    如何在Github的README上添加R-CMD检查状态

  29. 29

    如何将彩色文本放入github的README.md或Index.md文件

热门标签

归档