Skip to content

Commit

Permalink
Merge pull request #3385 from rtfd/faq-404
Browse files Browse the repository at this point in the history
Document why sometimes your docs 404 after a successful build.
  • Loading branch information
RichardLitt authored Dec 8, 2017
2 parents 5ccf163 + cfcea3d commit 8da5327
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://www.w3.org/Provider/Style/URI.html>`_.

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?
-------------------------------------------

Expand Down

0 comments on commit 8da5327

Please sign in to comment.