Skip to content

Add indexer and str to API documentation #5124

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 15, 2013
Merged

Add indexer and str to API documentation #5124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb4e69e
Add a convenience function to compile pandas ready for doc-building
jankatins Oct 6, 2013
ea1a2d5
Add some new entries to API doc
jankatins Oct 3, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion doc/make.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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():
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is covered by make doc already.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm on windows :-) And it doesn't seem to be in the makefile (at least make doc has no compile step)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this make it trigger on any attempt to build?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not that I know. I simple tried to get the doc build working (cd doc; python make.py html -> error) and had to C&P from the build_prev function to the commandline and was fed up after the second time :-) Now its cd doc; python make.py build_pandas; python make.py html

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as long as this doesn't cause doc builds to wipe and rebuild pandas, it's fine with me.

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('..')
Expand Down Expand Up @@ -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,
}

Expand Down
71 changes: 68 additions & 3 deletions doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ Top-level dealing with datetimes
:toctree: generated/

to_datetime
to_timedelta

Top-level evaluation
~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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/

Expand Down Expand Up @@ -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
Expand All @@ -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::
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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/
Expand Down Expand Up @@ -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::
Expand Down