Skip to content

Invalid message on just imported / simple repositories #3351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
humitos opened this issue Dec 4, 2017 · 5 comments
Closed

Invalid message on just imported / simple repositories #3351

humitos opened this issue Dec 4, 2017 · 5 comments
Labels
Good First Issue Good for new contributors Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Dec 4, 2017

When you create a project in github with just a README.md and import it on RTD, you get this message:

captura de pantalla_2017-12-04_10-14-16

This message is wrong since the PATH of those failes are invalid/useless for the user. I think this is generated by Sphinx automatically, so I'm not sure if we can change that easily.

@humitos humitos added the Improvement Minor improvement to code label Dec 4, 2017
@humitos humitos added the Good First Issue Good for new contributors label Dec 22, 2017
@stsewd
Copy link
Member

stsewd commented Dec 23, 2017

Where is generated this file? The only relevant file I found is this https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl :/

Maybe passing some additional context?

@humitos
Copy link
Member Author

humitos commented Dec 23, 2017

Not really sure but IIRC this file is generated by Sphinx itself, maybe that it's something that could help you to find out :/

@stsewd
Copy link
Member

stsewd commented Dec 25, 2017

Found! https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/base.py#L104

So, what should we put on there? Something like this?

Create an index file on your repository (or docs).

@humitos
Copy link
Member Author

humitos commented Dec 25, 2017

Nice!

Please create an ``index.{ext}`` or ``README.{ext}`` file with your own content under the root directory in your repository (or under ``/docs`` directory).

Maybe something like that?

@stsewd
Copy link
Member

stsewd commented Dec 25, 2017

@humitos PR on the way!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good for new contributors Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

2 participants