Skip to content

DOC: Add datatest package to list of third-party extension accessors. #38593

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 1 commit into from
Dec 21, 2020
Merged

DOC: Add datatest package to list of third-party extension accessors. #38593

merged 1 commit into from
Dec 21, 2020

Conversation

shawnbrown
Copy link
Contributor

This change adds the datatest package to the list of third-party extension accessors. Since datatest supports more than pandas, I wasn't sure if it was appropriate to add it to the Data cleaning and validation section, so I only added it to the accessors list for now.

Unfortunately, the "Classes" column was not wide enough--so this patch affects all rows in the table. This shouldn't happen again as the column is now wide enough to accommodate all of the classes that support extension accessors.

@shawnbrown
Copy link
Contributor Author

shawnbrown commented Dec 20, 2020

I'm not sure what to make of this. The changes I made don't seem to be an issue according to the "Build documentation" logs:

The successful build used Sphinx v3.3.1 and the failing build used Sphinx v3.4.0. In the successful build, there are warnings emitted after the success. But in the failing build, these same warnings are emitted during the process--causing it to fail.

EDIT: Correction, there are additional warnings in the failing build that aren't in the passing build (see following comment).

@shawnbrown
Copy link
Contributor Author

This seems to be happening for files totally unrelated to the change. The failing Build documentation step emits warnings that the passing build did not. This seems to have started with the newly published Sphinx v3.4.0 (released earlier today). The new warnings are as follows:

/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

@shawnbrown
Copy link
Contributor Author

@jreback
Copy link
Contributor

jreback commented Dec 20, 2020

e should pin sphinx to the earlier version
for now (and open an issue to fix)

want to do a PR?

@shawnbrown
Copy link
Contributor Author

want to do a PR?

Sure. I'll post in a minute.

@jreback jreback added the Docs label Dec 21, 2020
@jreback jreback added this to the 1.3 milestone Dec 21, 2020
@jreback jreback merged commit d3c52e4 into pandas-dev:master Dec 21, 2020
@jreback
Copy link
Contributor

jreback commented Dec 21, 2020

thanks @shawnbrown

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