Skip to content

Commit

Permalink
Merge pull request #91 from huonw/mention-orphan
Browse files Browse the repository at this point in the history
Remind about `:orphan:` in 404.rst, to silence build warnings
  • Loading branch information
humitos committed May 31, 2020
2 parents bd75c1d + 7e22517 commit 76058a2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For other use cases, you can customize these configuration options in your ``con

Type: dict

Notes: If you prefer, you can create a file called ``404.rst`` and use reStructuredText to create the context of your ``404.html`` page.
Notes: If you prefer, you can create a file called ``404.rst`` and use reStructuredText to create the context of your ``404.html`` page. Add the ``:orphan:`` `metadata <https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#metadata>`__ to the top of ``404.rst``, to silence the spurious ``document isn't included in any toctree`` warning.

.. confval:: notfound_pagename

Expand Down

0 comments on commit 76058a2

Please sign in to comment.