3 projects, 3 problems

[barbara-sfx]

Details

I'm totally new to RTD and have created 3 projects using markdown doc type. They are all private. Two link to public repo's and one links to a private repo. Here are my problems.

1. Public repo when a project is deleted, it can't be created again #1 builds successfully but doc links are 404. There is a readme.md file in the repo.
2. Public repo it doesn't pull docstrings from python sources #2 builds successfully but doc displays autogenerated index file. (Could this be because the readme file is named readme and not readme.md?)
3. Private repo hangs on Cloning.

I'd appreciate insight on any of these. Thanks.

[willingc]

1. If the link is causing a 404, perhaps there is a typo in the link or the site requires https or http. If you run make linkcheck if using Sphinx, it may give you some indication.
2. I'm not quite sure what you are asking here. Perhaps a link to the public repo that you are using would assist others in answering your question.
3. Again more detail would be helpful here. If it's hanging on Cloning while trying to build the docs, it is usually caused by an error in either the requirements file or in the settings that you entered on the read the docs settings pages.

[barbara-sfx]

Thanks for your response.

1. No typos, I checked. Public repo is https://github.com/signalfx/appd-integration. I'm not using sphinx, just RTD online.
2. Public repo is https://github.com/signalfx/collectd.git. I get an error: This is an autogenerated index file.

Please create a /home/docs/checkouts/readthedocs.org/user_builds/collectd/checkouts/latest/index.md or /home/docs/checkouts/readthedocs.org/user_builds/collectd/checkouts/latest/README.md file with your own content.

I'm guessing it's because the readme doesn't have a .md extension. I can test another repo that does, but see #1. Which does have a readme.md. I don't have a local install so I'm thinking the message is just misleading.

1. No errors AFAIK. I created all my projects identically, changing them to private and to md i/o sphinx. I can try again when I have time. Repo is private - I thought that might be the problem....

Thanks again for taking the time to reply. I really appreciate it.

[willingc]

@barbara-sfx I've never used readthedocs without using Sphinx or mkdocs so I don't know about the possibility of building docs without either one. I'm not a core developer on readthedocs. I'm just someone that uses it quite a bit. Leaving this for maintainers to comment on.

FYI https://docs.readthedocs.org/en/latest/builds.html

[barbara-sfx]

Thanks @willingc. I'll read that and see if I can educate myself some more.

[humitos]

@barbara-sfx how are you building your documentation? RTD uses Sphinx or MkDocs. It doesn't sever HTML generated in another place that it's not by RTD using Sphinx or MkDocs. None of the public project you shared here have a correct structure for RTD to build your documentation.

I recommend you to take a look at this guide: http://docs.readthedocs.io/en/latest/getting_started.html

[benjaoming]

@humitos do you guys triage issues and close them often or just during sprints? There's quite a legacy of issues for RTD. This one can be closed for any of the following reasons IMO:

• Lack of feedback from OP
• Support related (as in, there are no unanswered questions here)
• Not clear what the actual issue is
• Mixing up 3 different issues in the same report makes it kind of invalid

I can't say point my finger at any kind of lack of information or documentation that has misguided the OP, so I wouldn't keep this open unless someone comes and says "we should be more clear about only supporting MkDocs and Sphinx".

[stsewd]

Closing this as the user hasn't responded or given more information, feel free to reopen with more information if you are still having this problem :).