Skip to content

BUG: Temporarily pin the version of Sphinx to 3.3.1 in requirements. #38598

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

Merged
merged 3 commits into from
Dec 21, 2020
Merged

BUG: Temporarily pin the version of Sphinx to 3.3.1 in requirements. #38598

merged 3 commits into from
Dec 21, 2020

Conversation

shawnbrown
Copy link
Contributor

A recent change in Sphinx v3.4.0 is breaking pandas' CI Build documentation step.

Until this is resolved, we can temporarily pin Sphinx to the previous version (3.3.1).

Submitted in response to @jreback in #38593 (comment)


Here's some info that might help for getting this sorted, long term:

Sphinx Changelog: Release 3.4.0 (released Dec 20, 2020)
https://www.sphinx-doc.org/en/master/changes.html#release-3-4-0-released-dec-20-2020

CI build logs from some passing and failing builds:

While passing and failing builds both emit warnings, the following warnings are exclusive to the failing builds under Sphinx 3.4.0:

/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessDay.rst:18: WARNING: autosummary: failed to import base
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessDay.rst:18: WARNING: autosummary: failed to import offset
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessDay.rst:40: WARNING: autosummary: failed to import __call__
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessDay.rst:40: WARNING: autosummary: failed to import rollback
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessDay.rst:40: WARNING: autosummary: failed to import rollforward
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthBegin.rst:18: WARNING: autosummary: failed to import base
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthBegin.rst:36: WARNING: autosummary: failed to import __call__
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthBegin.rst:36: WARNING: autosummary: failed to import rollback
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthBegin.rst:36: WARNING: autosummary: failed to import rollforward
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthEnd.rst:18: WARNING: autosummary: failed to import base
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthEnd.rst:36: WARNING: autosummary: failed to import __call__
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthEnd.rst:36: WARNING: autosummary: failed to import rollback
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.BusinessMonthEnd.rst:36: WARNING: autosummary: failed to import rollforward
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:18: WARNING: autosummary: failed to import base
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:18: WARNING: autosummary: failed to import cbday_roll
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:18: WARNING: autosummary: failed to import month_roll
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:18: WARNING: autosummary: failed to import offset
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:43: WARNING: autosummary: failed to import __call__
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:43: WARNING: autosummary: failed to import rollback
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthBegin.rst:43: WARNING: autosummary: failed to import rollforward
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:18: WARNING: autosummary: failed to import base
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:18: WARNING: autosummary: failed to import cbday_roll
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:18: WARNING: autosummary: failed to import month_roll
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:18: WARNING: autosummary: failed to import offset
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:43: WARNING: autosummary: failed to import __call__
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:43: WARNING: autosummary: failed to import rollback
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessMonthEnd.rst:43: WARNING: autosummary: failed to import rollforward
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessDay.rst:18: WARNING: autosummary: failed to import base
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessDay.rst:18: WARNING: autosummary: failed to import offset
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessDay.rst:40: WARNING: autosummary: failed to import __call__
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessDay.rst:40: WARNING: autosummary: failed to import rollback
/home/runner/work/pandas/pandas/doc/source/docstring of pandas._libs.tslibs.offsets.CustomBusinessDay.rst:40: WARNING: autosummary: failed to import rollforward

@jreback jreback added this to the 1.2 milestone Dec 21, 2020
@jreback jreback added the Docs label Dec 21, 2020
@jreback
Copy link
Contributor

jreback commented Dec 21, 2020

lgtm ping in green

@jreback jreback merged commit b7c994b into pandas-dev:master Dec 21, 2020
@jreback
Copy link
Contributor

jreback commented Dec 21, 2020

thanks @shawnbrown

meeseeksmachine pushed a commit to meeseeksmachine/pandas that referenced this pull request Dec 21, 2020
simonjayhawkins pushed a commit that referenced this pull request Dec 21, 2020
luckyvs1 pushed a commit to luckyvs1/pandas that referenced this pull request Jan 20, 2021
…andas-dev#38598)

* BUG: Temporarily pin the version of Sphinx to 3.3.1 in requirements.

Currently, the CI "Build documentation" step is failing with Sphinx 3.4.0.

* Temporarily pin Sphinx version in environment.yml (See 1a03918).

* Correct version definition in environment.yml file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants