Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 1 commit into from

Conversation

amotl
Copy link
Member

@amotl amotl commented Oct 28, 2024

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?

@cla-bot cla-bot bot added the cla-signed label Oct 28, 2024
Copy link
Member Author

@amotl amotl Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@amotl
Copy link
Member Author

amotl commented Oct 28, 2024

@BaurzhanSakhariev reported:

Cleaning up docs directory helped.

🤷

@amotl amotl closed this Oct 28, 2024
@amotl amotl deleted the rm-furo-readme branch October 28, 2024 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant