Problems after RTD update

[nikolay-bushkov]

Details

• Read the Docs project URL: https://readthedocs.org/projects/deeppavlov/
• Build URL (if applicable): https://readthedocs.org/projects/deeppavlov/builds/7498176/
• Read the Docs username (if applicable): nikolay-bushkov

Expected Result

Successful build

Actual Result

Error
There was a problem with Read the Docs while building your documentation. Please report this to us with your build id (7498176).

At the beginning of this summer, we (deepavlov.ai) decided to move our docs to RTD and spent several hours before getting a successful build. There were 2 branches (versions) deployed as expected several times after new commits but then we paused our efforts in order to make some refactoring of the library at first.

Yesterday, we started to work on docs again but it was not possible to build a new branch/version. Every attempt to make RTD works finished with the error described above. Moreover, RTD could not build both old branches now, despite the fact that no changes were made to them in the last weeks.
I tried to wipe every version, to recreate the project from scratch several times, but nothing helped.

Today's update of RTD to 2.6.0 also had no effect. Such error messages as mentioned above give little info for debug, so any thoughts would be appreciated.
Thanks in advance.

[gregurco]

@nikolay-bushkov you are not the first 🙂 read #4380 and #4381

[nikolay-bushkov]

@gregurco I saw that, and many other issues in this repo for a previous couple of months, but I use sphinx (not mkdocs), have no clues that pip is the cause, and experienced the problem even yesterday (with 2.5.3, I guess).

[humitos]

@nikolay-bushkov thanks for your report.

I was able to import your project locally but I noticed that you are using an specific build image (latest) in your YAML conf. I change that to readthedocs/build:3.0 which is the latest stable and it did worked.

Although, I changed that in production and I wasn't able to build the docs anyway. The error that we are getting is a UnicodeEncodeError which I thought that I was related to our usage of gitpython methods or similar but I didn't find it yet.

I'm marking this as a bug since it's something in our side. In fact, it's happening only in production at the moment.

[humitos]

I jumped in into the builder log and I found the issue:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/readthedocs/projects/tasks.py", line 398, in run_setup
    self.setup_vcs()
  File "/home/docs/checkouts/readthedocs.org/readthedocs/projects/tasks.py", line 526, in setup_vcs
    self.sync_repo()
  File "/home/docs/checkouts/readthedocs.org/readthedocs/projects/tasks.py", line 140, in sync_repo
    } for v in version_repo.branches
  File "/home/docs/checkouts/readthedocs.org/readthedocs/vcs_support/backends/git.py", line 145, in branches
    return self.parse_branches(stdout)
  File "/home/docs/checkouts/readthedocs.org/readthedocs/vcs_support/backends/git.py", line 166, in parse_branches
    for branch in raw_branches:
UnicodeEncodeError: 'ascii' codec can't encode characters in position 9-10: ordinal not in range(128)

There is a combination of libraries versions in production that makes this fails.

build03 versions:

• python 2.7.12
• git 2.7.4
• gitpython 2.1.10

Locally, I'm running:

• python 3.6.6
• git 2.18.0
• gitpython 2.1.10

[stsewd]

@humitos if the issue is with unicode characters in branches, that is already reported in #3060

[humitos]

@stsewd I'm not 100% sure that it's exactly the same. In this case there is no branch with unicode chars on their names (click on the git branch -r in https://readthedocs.org/projects/deeppavlov/builds/7502116/)

I also checked that output with the output from my local instance and it's the same which is kind of confusing 😕

[stsewd]

@humitos after debugging a while, I found that there is a unicode character ау https://github.com/deepmipt/DeepPavlov/tree/%D0%B0%D1%83/ https://unicode-table.com/en/0443/ very hard to find p:

@nikolay-bushkov you need to remove/rename that branch and everything should work.

[nikolay-bushkov]

@stsewd thanks, it works!

[humitos]

@humitos after debugging a while, I found that there is a unicode character ау deepmipt/DeepPavlov@%D0%B0%D1%83 unicode-table.com/en/0443 very hard to find p:

Wow! How did you find that!?

Thanks @stsewd for debugging this and help @nikolay-bushkov to workaround the issue.

[stsewd]

@humitos iterating the branches, catching the error and seeing to which branch everything worked, the next branch should be the guilty p: