-
Notifications
You must be signed in to change notification settings - Fork 326
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
remove pandas API from the documentation #1330
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually I just approved but it looks like this page is still there?
https://pydata-sphinx-theme--1330.org.readthedocs.build/en/1330/examples/example_pandas.html
that was on purpose. This is entirely copy/pasted in our doc so whatever happens to pandas this page will continue to work. As it's a rather complete example of what a doc page could look like, I find it interesting to keep it. What I focused on is the pages that were based on API doctrings i.e. raising error whenever pandas was updated. I'm +1 to keep it. |
OK I understand that motivation, but the occasional changes to the expected warnings are not what #1309 complains about. It is about including docs from other packages in our own docs (irrespective of whether they're copy-pasted or "live"). And I think my points in #1309 still stand:
OK but why not just look at https://pandas.pydata.org/docs/ then? |
One could argue that we have no guarantee the pydata projects will always use the last version, unlike this page. |
thx @12rambau |
As suggested in the associated PR, I dropped the use of the pandas API to create the API page. Instead I kept the copy/pasted example (so that people know how it could look like when using templates).
Also I added an extra API page to the documentation to showcase the methods exposed by pydata_sphinx_theme.
Fix #1309