Fix readthedocs build #1561
Fix readthedocs build #1561
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1561 +/- ##
=======================================
Coverage 100.0% 100.0%
=======================================
Files 234 234
Lines 16827 16827
=======================================
Hits 16819 16819
Misses 8 8 Continue to review full report at Codecov.
|
| @@ -19,8 +19,7 @@ formats: | |||
|
|
|||
| # Optionally set the version of Python and requirements required to build your docs | |||
| python: | |||
| version: 3.7 | |||
| version: 3.8 | |||
There was a problem hiding this comment.
I don't think this was necessary but it seemed like a good idea
This reverts commit c1b923d.
dsherry
force-pushed
the
ds_1520_rtd_build_3
branch
from
f63578a
to
557f45d
Compare
| @@ -262,7 +268,7 @@ jobs: | |||
| python_version: "3.8" | |||
| steps: | |||
| - checkout | |||
| - install_dependencies_dev | |||
| - install_dependencies_docs | |||
There was a problem hiding this comment.
Did this just so that the circleci build_docs job would have the same deps installed by us as on RTD.
There was a problem hiding this comment.
If the goal is to have the same deps as RTD, shouldn't we install setuptools>=45.1.0 before installing our package?
There was a problem hiding this comment.
@freddyaboulton I'd say my goal here was to have the circleci job have deps which are closer to whats used on the RTD docker image.
If we really wanted to go the extra mile, I think we should write a job which duplicates the RTD build in its entirety, including the docker image. We could write that automation ourselves, or we could see if there's something in the community which we can use.
Given that we're considering migrating to github actions early next year, I think we should punt on this question. But great thinking
| pydata-sphinx-theme>=0.3.1 | ||
| Sphinx>=2.0.1 | ||
| nbconvert>=5.5.0 | ||
| nbsphinx>=0.4.2 |
There was a problem hiding this comment.
I made two changes here:
- Separated this out from
dev-requirements.txtso that.readthedocs.ymlcan install these deps without having to install the others. - Changed these versions to be minimums instead of pinning. This means we use Sphinx 3.3.1 now.
I didn't confirm that these changes were necessary in order to fix the bug, it just felt like a good way to reduce complexity, speed up the build, to only install the minimum required deps in each RTD build, and to potentially get some Sphinx/other bugfixes.
| install: | ||
| - requirements: docs/readthedocs-requirements.txt |
There was a problem hiding this comment.
This line is the fix: install setuptools>=45.1.0 before installing the docs requirements (sphinx etc) and our package itself.
| @@ -1,10 +1,6 @@ | |||
| -r requirements.txt | |||
| -r test-requirements.txt | |||
| -r docs-requirements.txt | |||
There was a problem hiding this comment.
I just moved the deleted lines into docs-requirements.txt below
| .PHONY: installdeps-docs | ||
| installdeps-docs: | ||
| pip install -e . -q | ||
| pip install -r docs-requirements.txt -q |
There was a problem hiding this comment.
This is used by the circleci build_docs code at the top and isn't part of the bugfix itself.
dsherry
requested review from
angela97lin,
bchen1116,
jeremyliweishih and
ParthivNaresh
There was a problem hiding this comment.
@dsherry Heroic! Thanks for fixing this before our next release. Please let us know what RTD says about this. I'm curious why they were installing an older version of setuptools.
| @@ -262,7 +268,7 @@ jobs: | |||
| python_version: "3.8" | |||
| steps: | |||
| - checkout | |||
| - install_dependencies_dev | |||
| - install_dependencies_docs | |||
There was a problem hiding this comment.
If the goal is to have the same deps as RTD, shouldn't we install setuptools>=45.1.0 before installing our package?
| @@ -19,8 +19,7 @@ formats: | |||
|
|
|||
| # Optionally set the version of Python and requirements required to build your docs | |||
| python: | |||
| version: 3.7 | |||
| version: 3.8 | |||
|
RTD came back green |
Fix #1520