Skip to content

Commit 9f853d2

Browse files
committed
DOC: api.rst updates
1 parent 09df295 commit 9f853d2

File tree

2 files changed

+42
-50
lines changed

2 files changed

+42
-50
lines changed

doc/source/api.rst

Lines changed: 41 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,8 @@ API Reference
77

88
.. _api.functions:
99

10-
General functions
11-
-----------------
12-
13-
Data manipulations
14-
~~~~~~~~~~~~~~~~~~
15-
.. currentmodule:: pandas.tools.pivot
16-
17-
.. autosummary::
18-
:toctree: generated/
19-
20-
pivot_table
21-
22-
.. currentmodule:: pandas.tools.merge
23-
24-
.. autosummary::
25-
:toctree: generated/
26-
27-
merge
28-
concat
10+
Input/Output
11+
------------
2912

3013
Pickling
3114
~~~~~~~~
@@ -38,8 +21,9 @@ Pickling
3821
load
3922
save
4023

41-
Flat File IO
42-
^^^^^^^^^^^^
24+
Flat File
25+
~~~~~~~~~
26+
4327
.. currentmodule:: pandas.io.parsers
4428

4529
.. autosummary::
@@ -50,6 +34,9 @@ Flat File IO
5034
read_fwf
5135
read_clipboard
5236

37+
Excel
38+
~~~~~
39+
5340
.. currentmodule:: pandas.io.excel
5441

5542
.. autosummary::
@@ -58,51 +45,45 @@ Flat File IO
5845
read_excel
5946
ExcelFile.parse
6047

61-
.. currentmodule:: pandas.io.stata
62-
63-
.. autosummary::
64-
:toctree: generated/
65-
66-
read_stata
48+
HTML
49+
~~~~
6750

6851
.. currentmodule:: pandas.io.html
6952

70-
HTML IO
71-
^^^^^^^
7253
.. autosummary::
7354
:toctree: generated/
7455

7556
read_html
7657

77-
SQL
78-
~~~
58+
HDFStore: PyTables (HDF5)
59+
~~~~~~~~~~~~~~~~~~~~~~~~~
7960

80-
.. currentmodule:: pandas.io.sql
61+
.. currentmodule:: pandas.io.pytables
8162

8263
.. autosummary::
8364
:toctree: generated/
8465

85-
read_sql
66+
read_hdf
67+
HDFStore.put
68+
HDFStore.append
69+
HDFStore.get
70+
HDFStore.select
8671

87-
SQL IO
88-
^^^^^^
72+
SQL
73+
~~~
8974
.. currentmodule:: pandas.io.sql
9075

9176
.. autosummary::
9277
:toctree: generated/
9378

79+
read_sql
9480
read_frame
9581
write_frame
9682

97-
.. currentmodule:: pandas.io
9883

99-
.. autosummary::
100-
:toctree: generated/
101-
102-
sql
84+
STATA
85+
~~~~~
10386

104-
STATA IO
105-
^^^^^^^^
10687
.. currentmodule:: pandas.io.stata
10788

10889
.. autosummary::
@@ -115,19 +96,26 @@ STATA IO
11596
StataReader.variable_labels
11697
StataWriter.write_file
11798

118-
HDFStore: PyTables (HDF5)
119-
~~~~~~~~~~~~~~~~~~~~~~~~~
12099

121-
.. currentmodule:: pandas.io.pytables
100+
General functions
101+
-----------------
102+
103+
Data manipulations
104+
~~~~~~~~~~~~~~~~~~
105+
.. currentmodule:: pandas.tools.pivot
122106

123107
.. autosummary::
124108
:toctree: generated/
125109

126-
read_hdf
127-
HDFStore.put
128-
HDFStore.append
129-
HDFStore.get
130-
HDFStore.select
110+
pivot_table
111+
112+
.. currentmodule:: pandas.tools.merge
113+
114+
.. autosummary::
115+
:toctree: generated/
116+
117+
merge
118+
concat
131119

132120
Top-level Missing Data
133121
~~~~~~~~~~~~~~~~~~~~~~
@@ -386,6 +374,7 @@ Serialization / IO / Conversion
386374
Series.to_dict
387375
Series.to_sparse
388376
Series.to_string
377+
Series.to_clipboard
389378

390379
.. _api.dataframe:
391380

@@ -613,6 +602,7 @@ Serialization / IO / Conversion
613602
DataFrame.to_records
614603
DataFrame.to_sparse
615604
DataFrame.to_string
605+
DataFrame.to_clipboard
616606

617607
.. _api.panel:
618608

@@ -772,4 +762,5 @@ Serialization / IO / Conversion
772762
Panel.to_excel
773763
Panel.to_sparse
774764
Panel.to_frame
765+
Panel.to_clipboard
775766

doc/source/faq.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ by several options, which you're encouraged to tweak to suit your setup.
3737

3838
As of 0.11.1, these are the relavent options, all under the `display` namespace,
3939
(e.g. display.width, etc'):
40+
4041
- notebook_repr_html: if True, IPython frontends with HTML support will display
4142
dataframes as HTML tables when possible.
4243
- expand_repr (default True): when the frame width cannot fit within the screen,

0 commit comments

Comments
 (0)