From cfcea3ddd8bcb07c00eaca08b264c38cfee43ef1 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Fri, 8 Dec 2017 08:35:49 -0800 Subject: [PATCH] Document why sometimes your docs 404 after a successful build. --- docs/faq.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/faq.rst b/docs/faq.rst index 0410cc65a13..9114532564e 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -20,6 +20,21 @@ You can delete and re-create the project with the proper name to get a new slug, but you really shouldn't do this if you have existing inbound links, as it `breaks the internet `_. +Help, my build passed but my documentation page is 404 Not Found! +----------------------------------------------------------------- + +This often happens becuase you don't have an `index.html` file being generated. +Make sure you have one of the following files: + + * `index.rst` + * `index.md` + +At the top level of your built documentation, +otherwise we aren't able to serve a "default" index page. + +To test if your docs actually built correctly, +you can navigate to a specific page (`/en/latest/README.html` for example). + How do I change behavior for Read the Docs? -------------------------------------------