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.

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

new "unexpected warning" during sphinx build #1307

Closed
drammock opened this issue Apr 25, 2023 · 3 comments · Fixed by #1310
Closed

new "unexpected warning" during sphinx build #1307

drammock opened this issue Apr 25, 2023 · 3 comments · Fixed by #1310

Comments

@drammock
Copy link
Collaborator

This showed up in the CIs for #2717:

https://github.com/pydata/pydata-sphinx-theme/actions/runs/4796492713/jobs/8538010152

Unexpected warning: /opt/hostedtoolcache/Python/3.11.3/x64/lib/python3.11/site-packages/pandas/core/frame.py:docstring of pandas.core.frame.DataFrame.drop:1: WARNING: undefined label: 'advanced.shown_levels'

May need to add it to our list of expected warnings? Presumably caused by an upstream change in Pandas.

@12rambau
Copy link
Collaborator

should we fix pandas version instead ? (I never really dived in the documentation section but I assume freezeing the version should avoid these issues right ?

@drammock
Copy link
Collaborator Author

Personally I've never really liked the inclusion of pandas doc pages in our own docs. Given how widely used the theme is now (>6k users according to GitHub) I feel like we can trust that someone will tell us if things don't look good in their API docs. Also, we've recently made a few functions from our __init__.py public, which means we really ought to document those and include them in our online docs, which would provide a similar sort of test (smaller and probably less thorough, but IMO probably still good enough). WDYT?

@drammock
Copy link
Collaborator Author

for now though I think we should just add this warning to get CIs green again. I'll split out the question of keeping/removing pandas into a separate issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants