Skip to content
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

Catch enconding errors when reading the .readthedocs.yaml file #8482

Closed
AlexsLaboratory opened this issue Sep 13, 2021 · 7 comments
Closed
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@AlexsLaboratory
Copy link

Details:

Expected Result

I expected it to build the documentation using conda as the python environment manager

Actual Result

The result that turned out was a build error and I have no idea why as the error is not giving me much to work with in terms of troubleshooting.

@astrojuanlu astrojuanlu added the Support Support question label Sep 14, 2021
@astrojuanlu
Copy link
Contributor

Looks like the project is building again. Similar to #8474. Root causes still under investigation, we can't provide much information yet.

@humitos
Copy link
Member

humitos commented Sep 16, 2021

It seems like the project was deleted. I think we can close this issue. Feel free to re-open if it's still valid.

@humitos humitos closed this as completed Sep 16, 2021
@astrojuanlu
Copy link
Contributor

It was not deleted, but the original URL had incorrect capitalization I think https://readthedocs.org/projects/tripalgeoserverapi/

@humitos
Copy link
Member

humitos commented Sep 16, 2021

Oh, OK! Interesting that the build URL doesn't work either.

In any case, the latest 4 builds in that project did work https://readthedocs.org/projects/tripalgeoserverapi/builds/ so I think this was a temporal error too.

@Lowe-Man please, report back if you keep having this issue.

@AlexsLaboratory
Copy link
Author

AlexsLaboratory commented Sep 16, 2021

Oh, OK! Interesting that the build URL doesn't work either.

In any case, the latest 4 builds in that project did work https://readthedocs.org/projects/tripalgeoserverapi/builds/ so I think this was a temporal error too.

@Lowe-Man please, report back if you keep having this issue.

So the issue was that the .readthedocs.yaml file was for some reason encoded using something other than UTF-8. So the characters were coming up in what looked to be in Japanese or Chinese. After going into my IDE and changing the enoding for that file everything was resolved. I figured all of this out after installing readthedocs on a virtual machine to get a more descript error message.

@stsewd
Copy link
Member

stsewd commented Sep 16, 2021

I think we can catch that error and show a useful message to the user.

@stsewd stsewd reopened this Sep 16, 2021
@stsewd stsewd changed the title Build error with build id #14699679 Catch enconding errors when reading the .readthedocs.yaml file Sep 16, 2021
@stsewd stsewd added Improvement Minor improvement to code and removed Support Support question labels Sep 16, 2021
@humitos humitos added the Accepted Accepted issue on our roadmap label Jan 27, 2022
@humitos
Copy link
Member

humitos commented Jan 24, 2024

So the issue was that the .readthedocs.yaml file was for some reason encoded using something other than UTF-8.

In #10922 we added an extra line when showing this error message to give users a hit about this particular issue: https://github.com/readthedocs/readthedocs.org/blob/main/readthedocs/config/notifications.py#L20

@humitos humitos closed this as completed Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

4 participants