Skip to content

Fix documentation build with pandas 2.0#10138

Merged
jrbourbeau merged 1 commit intodask:mainfrom
jrbourbeau:pandas-2.0-docs-fixup
Apr 3, 2023
Merged

Fix documentation build with pandas 2.0#10138
jrbourbeau merged 1 commit intodask:mainfrom
jrbourbeau:pandas-2.0-docs-fixup

Conversation

@jrbourbeau
Copy link
Member

@jrbourbeau jrbourbeau commented Apr 3, 2023

Our documentation build is currently failing since the pandas=2.0 release came out earlier today (see this build). This is because a few methods in the DataFrame API were removed

/home/docs/checkouts/readthedocs.org/user_builds/dask/checkouts/10137/docs/source/dataframe-api.rst:9: WARNING: autosummary: failed to import DataFrame.append.
Possible hints:
* AttributeError: type object 'DataFrame' has no attribute 'append'
* ModuleNotFoundError: No module named 'dask.dataframe.DataFrame'
* ModuleNotFoundError: No module named 'DataFrame'
* KeyError: 'DataFrame'
* ImportError: 
/home/docs/checkouts/readthedocs.org/user_builds/dask/checkouts/10137/docs/source/dataframe-api.rst:148: WARNING: autosummary: failed to import Series.append.
Possible hints:
* ModuleNotFoundError: No module named 'dask.dataframe.Series'
* KeyError: 'Series'
* AttributeError: type object 'Series' has no attribute 'append'
* ModuleNotFoundError: No module named 'Series'
* ImportError: 
/home/docs/checkouts/readthedocs.org/user_builds/dask/checkouts/10137/docs/source/dataframe-api.rst:148: WARNING: autosummary: failed to import Series.iteritems.
Possible hints:
* ModuleNotFoundError: No module named 'dask.dataframe.Series'
* KeyError: 'Series'
* ModuleNotFoundError: No module named 'Series'
* ImportError: 
* AttributeError: type object 'Series' has no attribute 'iteritems'

This PR removes those corresponding methods from our API docs.

cc @j-bennet @phofl

@github-actions github-actions bot added the documentation Improve or add to documentation label Apr 3, 2023
@jrbourbeau jrbourbeau mentioned this pull request Apr 3, 2023
Closed
j-bennet
j-bennet approved these changes Apr 3, 2023
View reviewed changes
Copy link
Contributor

@j-bennet j-bennet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jrbourbeau
Copy link
Member Author

jrbourbeau commented Apr 3, 2023

Thanks for reviewing @j-bennet! As this is a pure docs change, and the docs build has passed, I'm going to merge this in to free up CI resources for other PRs

@jrbourbeau jrbourbeau merged commit 81e8de7 into dask:main Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@j-bennet j-bennet j-bennet approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improve or add to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jrbourbeau @j-bennet