Skip to content

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

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
mgeier opened this issue Jul 12, 2018 · 5 comments
Labels
Support Support question

Comments

@mgeier
Copy link
Contributor

mgeier commented Jul 12, 2018

Details

Expected Result

Successful build.

Actual Result

Build failed with this error message:

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

I've "wiped" the build previously, because there have been other issues before, e.g. an error during "Installing setuptools, pip, wheel...": https://readthedocs.org/projects/splines/builds/7476053/.

@RichardLitt RichardLitt added the Support Support question label Jul 12, 2018
@mgeier
Copy link
Contributor Author

mgeier commented Jul 12, 2018

Reporting this already helped, now it works: https://readthedocs.org/projects/splines/builds/7476771/

@stsewd
Copy link
Member

stsewd commented Jul 12, 2018

I think some of the failures are related to memory limits, maybe you want to check https://docs.readthedocs.io/en/latest/guides/build-using-too-many-resources.html

If this isn't a problem anymore, can we close this issue?

@mgeier
Copy link
Contributor Author

mgeier commented Jul 13, 2018

Thanks for the hint, @stsewd!

I don't know what went wrong in the case that I reported, you should decide if this issue should be closed or not.

Here are some observations I made, in case somebody stumbles upon this issue:

  • it's definitely helpful to reduce the number of output formats, especially if they are not needed anyway.

  • in my case I actually want to use those dependencies during the documentation build, but it turns out that using conda needs more memory than using the "normal" image.

  • I was using conda in the first place to get Python 3.6 support, but it turned out that this is also available for "normal" builds when using the latest image (see below).

  • I'm not sure about this, but I guess using the "system site-packages" reduces the number of packages that have to be installed, therefore reducing the memory usage. The option use_system_site_packages was quite hard to find, BTW.

Here is the readthedocs.yml that worked for me

build:
  image: latest

python:
  version: 3.6
  setup_py_install: true
  use_system_site_packages: true

requirements_file: doc/requirements.txt

formats: []

Please correct me if I'm wrong!

@mgeier
Copy link
Contributor Author

mgeier commented Jul 13, 2018

The time/memory usage could be further reduced if -E were not used when calling Sphinx, see #4363.

@stsewd
Copy link
Member

stsewd commented Jul 13, 2018

Thanks for reporting back! Yeah, using conda to only support python 3.6 is very heavy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Support Support question
Projects
None yet
Development

No branches or pull requests

3 participants