Skip to content

Commit 2e2b0b5

Browse files
committed
Add column object, add rst templates for better styling of methods/attrs
1 parent 1063641 commit 2e2b0b5

File tree

6 files changed

+41
-2
lines changed

6 files changed

+41
-2
lines changed
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _column-object:
2+
3+
Column object
4+
=============
5+
6+
A conforming implementation of the dataframe API standard must provide and
7+
support a column object having the following attributes and methods.
8+
9+
-------------------------------------------------
10+
11+
Methods
12+
-------
13+
TODO
14+
15+
..
16+
NOTE: please keep the methods in alphabetical order
17+
18+
.. currentmodule:: dataframe_api
19+
20+
.. autosummary::
21+
:toctree: generated
22+
:template: property.rst
23+

spec/API_specification/groupby_object.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _groupby-object:
22

3-
GroupBy object
3+
Groupby object
44
==============
55

66
A conforming implementation of the dataframe API standard must provide and

spec/API_specification/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ API specification
55

66
.. toctree::
77
:caption: API specification
8-
:maxdepth: 1
8+
:maxdepth: 3
99

1010
dataframe_object
11+
column_object
1112
groupby_object

spec/_templates/attribute.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. currentmodule:: {{ module }}
2+
3+
{{ name.split('.')[-1] | underline }}
4+
5+
.. autodata:: {{ name }}

spec/_templates/method.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. currentmodule:: {{ module }}
2+
3+
{{ name.split('.')[-1] | underline }}
4+
5+
.. autofunction:: {{ name }}

spec/_templates/property.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. currentmodule:: {{ module }}
2+
3+
{{ name.split('.')[-1] | underline }}
4+
5+
.. auto{{ objtype }}:: {{ objname }}

0 commit comments

Comments
 (0)