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

Read the docs CI build is quite erratic #2768

Closed
pbugnion opened this issue Feb 3, 2020 · 2 comments
Closed

Read the docs CI build is quite erratic #2768

pbugnion opened this issue Feb 3, 2020 · 2 comments
Labels
resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.

Comments

@pbugnion
Copy link
Member

pbugnion commented Feb 3, 2020

A few weeks ago, we turned on an RTD feature that builds on each PR. The hope was that having CI checks would lead to less broken documentation.

We addressed broken documentation by pointing to stable, rather than latest, so this is less relevant.

Separately, our RTD build fails regularly for various reasons:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/ipywidgets/envs/2679/lib/python3.7/site-packages/nbsphinx.py", line 891, in parse
    rststring, resources = exporter.from_notebook_node(nb, resources)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ipywidgets/envs/2679/lib/python3.7/site-packages/nbsphinx.py", line 783, in from_notebook_node
    nb, resources = pp.preprocess(nb, resources)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ipywidgets/envs/2679/lib/python3.7/site-packages/nbconvert/preprocessors/execute.py", line 405, in preprocess
    nb, resources = super(ExecutePreprocessor, self).preprocess(nb, resources)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ipywidgets/envs/2679/lib/python3.7/site-packages/nbconvert/preprocessors/base.py", line 69, in preprocess
    nb.cells[index], resources = self.preprocess_cell(cell, resources, index)
  File "/home/docs/checkouts/readthedocs.org/user_builds/ipywidgets/envs/2679/lib/python3.7/site-packages/nbconvert/preprocessors/execute.py", line 448, in preprocess_cell
    raise CellExecutionError.from_cell_and_msg(cell, out)
nbconvert.preprocessors.execute.CellExecutionError: An error occurred while executing the following cell:
------------------
file = open("images/WidgetArch.png", "rb")
image = file.read()
widgets.Image(
    value=image,
    format='png',
    width=300,
    height=400,
)

I'm not sure if it's our build process that's dubious or RTD that doesn't provide a stable environment, but this is currently slowing down development (I find myself re-triggering builds just to make RTD pass).

I propose removing the webhook. We still have a doc test on Github actions that tests the docs can be built. This seems much more versatile.

@jasongrout
Copy link
Member

It was nice being able to look at the built docs on a PR to check the doc changes, but I agree that the failing build has been frustrating. I'm fine with removing the webhook until we can get a more reliable build.

@pbugnion
Copy link
Member Author

pbugnion commented Feb 6, 2020

Thanks. I've deleted the webhook and tested a new PR to check the RTD build wasn't dispatched.

I presume existing pull requests will need an extra commit to make the cross go away.

@pbugnion pbugnion closed this as completed Feb 6, 2020
@lock lock bot added the resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label May 20, 2020
@lock lock bot locked as resolved and limited conversation to collaborators May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Projects
None yet
Development

No branches or pull requests

2 participants