Merge pull request #5124 from JanSchulz/API_additions

Add indexer and str to API documentation

Author: jreback

doc/make.py

@@ -72,7 +72,12 @@ def upload_prev(ver, doc_root='./'):
     if os.system(pdf_cmd):
         raise SystemExit('Upload PDF to %s from %s failed' % (ver, doc_root))
 
-
+def build_pandas():
+        os.chdir('..')
+        os.system('python setup.py clean')
+        os.system('python setup.py build_ext --inplace')
+        os.chdir('doc')
+        
 def build_prev(ver):
     if os.system('git checkout v%s' % ver) != 1:
         os.chdir('..')
@@ -238,6 +243,7 @@ def _get_config():
     'clean': clean,
     'auto_dev': auto_dev_build,
     'auto_debug': lambda: auto_dev_build(True),
+    'build_pandas': build_pandas,
     'all': all,
 }
 

doc/source/api.rst

@@ -153,6 +153,7 @@ Top-level dealing with datetimes
    :toctree: generated/
 
    to_datetime
+   to_timedelta
 
 Top-level evaluation
 ~~~~~~~~~~~~~~~~~~~~
@@ -253,10 +254,17 @@ Indexing, iteration
    :toctree: generated/
 
    Series.get
+   Series.at
+   Series.iat
    Series.ix
+   Series.loc
+   Series.iloc
    Series.__iter__
    Series.iteritems
 
+For more information on ``.at``, ``.iat``, ``.ix``, ``.loc``, and
+``.iloc``,  see the :ref:`indexing documentation <indexing>`.
+
 Binary operator functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
@@ -407,8 +415,49 @@ Time series-related
    Series.tz_convert
    Series.tz_localize
 
+String handling
+~~~~~~~~~~~~~~~~~~~
+``Series.str`` can be used to access the values of the series as
+strings and apply several methods to it. Due to implementation
+details the methods show up here as methods of the
+``StringMethods`` class.
+
+.. currentmodule:: pandas.core.strings
+
+.. autosummary::
+   :toctree: generated/
+
+   StringMethods.cat
+   StringMethods.center
+   StringMethods.contains
+   StringMethods.count
+   StringMethods.decode
+   StringMethods.encode
+   StringMethods.endswith
+   StringMethods.extract
+   StringMethods.findall
+   StringMethods.get
+   StringMethods.join
+   StringMethods.len
+   StringMethods.lower
+   StringMethods.lstrip
+   StringMethods.match
+   StringMethods.pad
+   StringMethods.repeat
+   StringMethods.replace
+   StringMethods.rstrip
+   StringMethods.slice
+   StringMethods.slice_replace
+   StringMethods.split
+   StringMethods.startswith
+   StringMethods.strip
+   StringMethods.title
+   StringMethods.upper
+
 Plotting
 ~~~~~~~~
+.. currentmodule:: pandas
+
 .. autosummary::
    :toctree: generated/
 
@@ -476,7 +525,11 @@ Indexing, iteration
    :toctree: generated/
 
    DataFrame.head
+   DataFrame.at
+   DataFrame.iat
    DataFrame.ix
+   DataFrame.loc
+   DataFrame.iloc
    DataFrame.insert
    DataFrame.__iter__
    DataFrame.iteritems
@@ -489,6 +542,10 @@ Indexing, iteration
    DataFrame.isin
    DataFrame.query
 
+For more information on ``.at``, ``.iat``, ``.ix``, ``.loc``, and
+``.iloc``,  see the :ref:`indexing documentation <indexing>`.
+
+
 Binary operator functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
@@ -733,14 +790,21 @@ Indexing, iteration, slicing
 .. autosummary::
    :toctree: generated/
 
+   Panel.at
+   Panel.iat
    Panel.ix
+   Panel.loc
+   Panel.iloc
    Panel.__iter__
    Panel.iteritems
    Panel.pop
    Panel.xs
    Panel.major_xs
    Panel.minor_xs
 
+For more information on ``.at``, ``.iat``, ``.ix``, ``.loc``, and
+``.iloc``,  see the :ref:`indexing documentation <indexing>`.
+
 Binary operator functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
@@ -878,8 +942,9 @@ Serialization / IO / Conversion
 Index
 -----
 
-**Many of these methods or variants thereof are available on the objects that contain an index (Series/Dataframe)
-and those should most likely be used before calling these methods directly.**
+**Many of these methods or variants thereof are available on the objects
+that contain an index (Series/Dataframe) and those should most likely be
+used before calling these methods directly.**
 
 .. autosummary::
    :toctree: generated/
@@ -1026,7 +1091,7 @@ Conversion
 
 ..
     HACK - see github issue #4539. To ensure old links remain valid, include
-    here the autosummaries with previous currentmodules as a comment and add 
+    here the autosummaries with previous currentmodules as a comment and add
     them to a hidden toctree (to avoid warnings):
 
 .. toctree::