GitHub 项目如何避免 README 和文档的内容重复？

[kxxoling]

打算把项目的 README 整理成结构更清晰的文档，想当然的使用了 rst 的 include，结果 GitHub 不认这种写法： https://github.com/kxxoling/PrettyTable/tree/develop

GitHub Markup 项目中也讨论了好久，但是一直没有后续消息，有什么比较干净的 workaround 推荐吗？

[SoloCompany]

不要直接放到 Readme 里面，然后通过 generate 出来的静态网站展示不就能解决问题了？

[kxxoling]

@SoloCompany 没明白。。现在的想法是在文档里 include 外面目录的 README，但是个人不喜欢这种 include，容易引起循环引用的问题。

[kcworms]

和#1一样的想法，考虑一下用github pages？把文档扔到里面再在readme里加个指向站点的链接。
或者扔到github wiki里

[kxxoling]

@kcworms 现在用的 RTFD。

[kcworms]

@kxxoling 你的意思是一定要把文档和代码放在一个repo甚至同branch里，而且还按内容拆成小文件，最后README必须合并显示这些小文件且不能复制粘贴吗

[kxxoling]

@kcworms 尽量这样吧。

[timpaik]

试试 README.rst 直接放到 docs 文件夹？