-
Notifications
You must be signed in to change notification settings - Fork 21
Render API docstrings in .py
files as html
#98
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
Conversation
The Sphinx templates help with better styling of methods/attrs
2e2b0b5
to
89d8ee5
Compare
============= | ||
|
||
A conforming implementation of the dataframe API standard must provide and | ||
support a column object having the following attributes and methods. |
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.
should column be capitalized?
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.
I didn't do that on purpose. Maybe one thing to discuss in the context of constructors is whether the name matters (Column
, DataFrame
, etc.). For array libraries we left this out on purpose, because it's never needed and existing libraries name these things differently. The same could apply here, unless you allow calling object.__init__
as a constructor.
a few nitpicks, otherwise looks fine |
CI is happy and comments are addressed, so I'll go ahead and merge this. |
CI for deploying is happy, rendered docs are up on https://data-apis.org/dataframe-api/draft/API_specification/index.html. |
This does the following:
spec/API_specification/dataframe_api/
is importableautodoc
Scalar
class needed aTypeVar
, but there should be more to do there.