Build passed but I can't see the documentation (maze screen)

[joshvillbrandt]

Details

• Project URL: https://github.com/joshvillbrandt/wireless
• Build URL (if applicable): http://wireless.readthedocs.io/en/latest/
• Read the Docs username (if applicable): joshvillbrandt

Actual Result

No docs. The empty maze screen instead. Similar to #2356 and #3246.

Expected Result

Expected to see docs. They previously existed here, but somehow disappeared. I have triggered new builds (which were successful but I still get the maze screen instead of docs).

Per the Build Process for Mkdocs documentation, it should be sufficient to only have a README.md file in the root of the directory.

[dearmond]

Me too: https://readthedocs.org/projects/sitefarm/

I have the README.md in the /docs/ directory, which per the documentation, should be sufficient.

[tynan-cr]

This has something to do with the README location (tested using a local deploy of RTD):

1. When README.md is in the root of the repo, the project doesn't convert it to index.md, but builds the rest of the docs just fine.

2. When README.md is in the docs folder, mkdocs is skipped entirely during the build process, resulting in an empty directory, and thus a 404.

[ericholscher]

Do you not have an index.md?

[dearmond]

I have a README.md in the /docs directory.

From the Build Process for Mkdocs documentation:

If you have a README.md, it will be transformed into an index.md automatically.

[jtyr]

I have the README.md file in the root of the repo and I'm getting 404 as well.

[stsewd]

I'm sorry you're having this issue, I think this is just a documentation problem (see #1954 (comment)).

You can access to your docs here:
@joshvillbrandt http://wireless.readthedocs.io/en/latest/README/
@dearmond http://sitefarm.readthedocs.io/en/latest/README/

[stsewd]

@jtyr you need an index.md file as mention above

[stsewd]

This was also a documentation problem, solved on d907524