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

remove pandas API from the documentation #1330

Merged
merged 12 commits into from
Jun 20, 2023
Merged

Conversation

12rambau
Copy link
Collaborator

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

@12rambau 12rambau marked this pull request as draft May 18, 2023 15:06
@12rambau 12rambau marked this pull request as ready for review May 18, 2023 21:03
Copy link
Collaborator

@drammock drammock left a 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

@12rambau
Copy link
Collaborator Author

12rambau commented Jun 8, 2023

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.

@drammock
Copy link
Collaborator

drammock commented Jun 8, 2023

that was on purpose. This is entirely copy/pasted in our doc so whatever happens to pandas this page will continue to work.

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:

  • 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
  • I'm dubious as to how diligent we are at scrutinizing those pages during PR reviews anyway

As it's a rather complete example of what a doc page could look like, I find it interesting to keep it.

OK but why not just look at https://pandas.pydata.org/docs/ then?

@12rambau
Copy link
Collaborator Author

12rambau commented Jun 9, 2023

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.

@12rambau 12rambau requested a review from drammock June 13, 2023 07:42
@drammock drammock merged commit cb23a7a into pydata:main Jun 20, 2023
@drammock
Copy link
Collaborator

thx @12rambau

@12rambau 12rambau deleted the pandas branch June 20, 2023 16:48
@drammock drammock mentioned this pull request Jun 20, 2023
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 this pull request may close these issues.

RFC: remove pandas docs pages from our doc build?
2 participants