Python 如何避免_init__uuuuuuuy.py和README.md中的重复

我有一个python包，它在每个

\uuuu init\uuuu.py

模块中都有简短的docstring，解释模块的功能等

该包托管在GitHub上，我希望让在线浏览存储库的用户能够轻松地看到这些信息。一种选择是将整个docstring从

\uuuu init\uuuu.py

复制到

README.md

文件中，但这违反了

---

有更好的解决办法吗？

不要走那条路。通常情况下，您可以通过其他方式提供文档（包括

\uuu init\uuuu

中的文档），例如sphinx和readthedocs是非常流行的atm。当然，我同意，这就是我们拥有它的原因。但是在github上浏览存储库时，最好能对我当前浏览的任何子目录做一个简短的介绍。但也许这是不可能的？您可以添加钩子，在合并或发布更改时自动生成这些钩子。然而，模块的文档（

\uuuu init\uuuu

）是针对用户的，github上的预览通常是针对开发人员的-这就是为什么通常不习惯对两者使用相同的“文档”。同意，但看到用户文档（至少对我来说）根本看不到文档。