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

Remind about :orphan: in 404.rst, to silence build warnings #91

Merged
merged 1 commit into from
May 31, 2020

Conversation

huonw
Copy link
Contributor

@huonw huonw commented May 20, 2020

A manual 404.rst page is typically not included in any toctrees and so will receive a warning like:

WARNING: document isn't included in any toctree

This warning is spurious, and can be controlled with the :orphan: file metadata. This PR adds a brief mention of :orphan: to remind people that it exists and is probably useful for the 404 page.

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

Thanks!

@humitos humitos merged commit 76058a2 into readthedocs:master May 31, 2020
@huonw huonw deleted the mention-orphan branch May 31, 2020 23:36
@huonw
Copy link
Contributor Author

huonw commented May 31, 2020

Thank you for merging!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants