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

CI: fix RTD builds on push to master #1816

Conversation

consideRatio
Copy link
Member

@consideRatio consideRatio commented Oct 7, 2020

It appears that when we build the docs in the PR preview, it works. But,
when we push to master, it doesn't any more. It appears that using
pydata_sphinx_theme to build PDFs and/or ePub files makes it crash if we
using sphinx3 rather than sphinx2. Since a doc dependency that
(executablebooks/myst-parser) previously was limited to sphinx 2 but not
longer is, the PDF / ePub build made our builds when pushing to master
fail.

I'd like to avoid maintaining these things, and would like to stop
building PDFs and ePub files. I don't know if they are used, but I'd
like to focus attention to https://z2jh.jupyter.org anyhow I think.


I'll self merge this now as to trial that this actually resolved the issue. If we want to have htmlzip / PDF / ePub builds again, I think we can pin sphinx<3 in doc-requirements.txt and configure formats: all in .readthedocs.yml instead of formats: [].

Here is an related issue about the build failure, which stems from the interaction of pydata_sphinx_theme and RTD builds like htmlzip it seems: pydata/pydata-sphinx-theme#177


Update

The build works!

It appears that when we build the docs in the PR preview, it works. But,
when we push to master, it doesn't any more. It appears that using
pydata_sphinx_theme to build PDFs and/or ePub files makes it crash if we
using sphinx3 rather than sphinx2. Since a doc dependency that
(executablebooks/myst-parser) previously was limited to sphinx 2 but not
longer is, the PDF / ePub build made our builds when pushing to master
fail.

I'd like to avoid maintaining these things, and would like to stop
building PDFs and ePub files. I don't know if they are used, but I'd
like to focus attention to https://z2jh.jupyter.org anyhow I think.
@consideRatio consideRatio merged commit 76c63f5 into jupyterhub:master Oct 7, 2020
@consideRatio
Copy link
Member Author

@jupyterhub/jupyterhubteam, do we wish to keep putting in work to ensure htmlzip, pdf, and ePub builds to function with our documentation, or only do standard html builds?

@manics
Copy link
Member

manics commented Oct 7, 2020

I didn't know we had zip/pdf/epub builds, nor can I think of a situation where I'd want to download those formats.

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

Successfully merging this pull request may close these issues.

2 participants