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.

Sign up for GitHub

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

Jump to bottom

fix the failing docs #8188

Merged
merged 5 commits into from
Sep 15, 2023
Merged

fix the failing docs #8188

merged 5 commits into from
Sep 15, 2023

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Sep 15, 2023

The docs have been failing because of a malformatted docstring we inherit from pandas, and this caused us to miss another error in #8183. The fix is to avoid installing pandas=2.1.0, which should be the only version with the malformatted docstring, and to apply the missing changes from #8183 here.

@github-actions github-actions bot added CI Continuous Integration tools dependencies Pull requests that update a dependency file labels Sep 15, 2023
@kmuehlbauer
Copy link
Contributor

@keewis The docstring is fixed already pandas-dev/pandas#55050 and should be release with pandas 2.1.1 around 20th of September. We can try to remove the pinning when that release is finally out.

@keewis
Copy link
Collaborator Author

keewis commented Sep 15, 2023

by pinning to !=2.1.0 I was hoping that 2.1.1 or 2.2.0 would automatically be picked up without us having to modify the environment file again.

@kmuehlbauer
Copy link
Contributor

by pinning to !=2.1.0 I was hoping that 2.1.1 or 2.2.0 would automatically be picked up without us having to modify the environment file again.

Great, overlooked that one.

@keewis
Copy link
Collaborator Author

keewis commented Sep 15, 2023

I'm going to merge this as soon as the tests pass

@keewis keewis enabled auto-merge (squash) September 15, 2023 13:03
@keewis keewis merged commit e00e31b into pydata:main Sep 15, 2023
@keewis keewis deleted the fix-docs branch September 15, 2023 13:26
@keewis
Copy link
Collaborator Author

keewis commented Sep 15, 2023 •
edited
Loading

that's interesting... I activated "auto merge", then restarted a ci job because one of the jobs was flaky (netcdf4 + multithreading), but automerge activated as soon as RTD was done, even though the restarted job is still running. This most likely won't affect main since it was just flaky, but this might also have been a mistake on my part so I would have liked for it to wait...

@max-sixty
Copy link
Collaborator

Thanks! Sorry I missed the error prior. Having the tests be green in the good state is very helpful for catching errors...

max-sixty pushed a commit to max-sixty/xarray that referenced this pull request Sep 17, 2023
@keewis @max-sixty
fix the failing docs (pydata#8188)
2cf4c7d 
* don't try to build with `pandas=2.1.0`

one of the docstrings we inherit from `pandas` is malformatted in that version

* reorder the project metadata sections

* source the exhaustive list of optional deps from `pyproject.toml`

* link to the new location of the colormap tutorial in matplotlib

* also convert the narrative documentation to `pyproject.toml`
@kmuehlbauer
Copy link
Contributor

kmuehlbauer commented Sep 20, 2023 •
edited
Loading

It looks like pandas milestoned the fix for 2.2 so we might have to revisit the pinning.

Update: This got a backport to 2.1.1 at the last minute 👍 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
CI Continuous Integration tools dependencies Pull requests that update a dependency file topic-plotting
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Doc build fails on pandas docstring
3 participants
@keewis @kmuehlbauer @max-sixty