Fix building docs at crate/crate by removing stray README.md

[amotl]

Problem

@BaurzhanSakhariev just reported:

5.9.1 tag creation failed with

Warning, treated as error:
...crate/docs/_out/html/_static/vendor/furo/README.md:document isn't included in any toctree
Docs build failed. Aborting

Does it look familiar to anyone?

[amotl]

Evaluation

For some reason, this informative README.md made it into the documentation tree and was picked up by Sphinx. That is clearly not intended, and we don't know why it (suddenly!?) happens on the blackbox setup of crate/crate.

Solution

Let's try to fix that problem by just renaming this file to README.txt.

[seut]

Why should the rename fix it?
Shouldn't it be deleted instead? Does it adds value to keep it?

[amotl]

The renaming should fix it, because Sphinx will not pick it up to be rendered from Markdown into HTML. By the way, I dont't actually know why it is being picked up now, but renaming it without much ado appeared to be the most easy fix for me.

[amotl]

I'd rather delete this file, I see no reason why it should stay inside the repo.

Sure, we can add the information inside to README or docs/something.

[amotl]

Done.

[amotl]

@BaurzhanSakhariev reported:

Cleaning up docs directory helped.

🤷

[seut]

I'd rather delete this file, I see no reason why it should stay inside the repo.

[seut]

thanks!