Added support for DataFrame generation in API Reference (#406)

docs/source/_templates/_api_ref.pandas.dataframe_templ.rst

@@ -0,0 +1,313 @@
+.. _api_ref.pandas.dataframe:
+.. include:: ./../ext_links.txt
+
+DataFrame
+=========
+.. currentmodule:: pandas
+
+This is the main `Pandas*`_ data structure representing a table of rows and columns.
+
+DataFrame is a two-dimensional structure with labeled axes. It can be thought of as a dictionary-like
+container for :class:`Series <pandas.Series>`
+
+Constructor
+-----------
+
+.. sdc_toctree
+   DataFrame
+
+Attributes/Operators
+--------------------
+
+.. sdc_toctree
+   DataFrame.index
+   DataFrame.columns
+   DataFrame.dtypes
+   DataFrame.select_dtypes
+   DataFrame.values
+   DataFrame.axes
+   DataFrame.ndim
+   DataFrame.size
+   DataFrame.shape
+   DataFrame.memory_usage
+   DataFrame.empty
+
+Type Conversions
+----------------
+
+.. sdc_toctree
+   DataFrame.astype
+   DataFrame.infer_objects
+   DataFrame.copy
+   DataFrame.isna
+   DataFrame.notna
+   DataFrame.bool
+
+Indexing and Iteration
+----------------------
+
+.. sdc_toctree
+   DataFrame.head
+   DataFrame.at
+   DataFrame.iat
+   DataFrame.loc
+   DataFrame.iloc
+   DataFrame.insert
+   DataFrame.__iter__
+   DataFrame.items
+   DataFrame.iteritems
+   DataFrame.keys
+   DataFrame.iterrows
+   DataFrame.itertuples
+   DataFrame.lookup
+   DataFrame.pop
+   DataFrame.tail
+   DataFrame.xs
+   DataFrame.get
+   DataFrame.isin
+   DataFrame.where
+   DataFrame.mask
+   DataFrame.query
+
+For more information on ``.at``, ``.iat``, ``.loc``, and
+``.iloc``,  see the :ref:`indexing documentation <indexing>`.
+
+Binary Operator Functions
+-------------------------
+
+.. sdc_toctree
+   DataFrame.add
+   DataFrame.sub
+   DataFrame.mul
+   DataFrame.div
+   DataFrame.truediv
+   DataFrame.floordiv
+   DataFrame.mod
+   DataFrame.pow
+   DataFrame.dot
+   DataFrame.radd
+   DataFrame.rsub
+   DataFrame.rmul
+   DataFrame.rdiv
+   DataFrame.rtruediv
+   DataFrame.rfloordiv
+   DataFrame.rmod
+   DataFrame.rpow
+   DataFrame.lt
+   DataFrame.gt
+   DataFrame.le
+   DataFrame.ge
+   DataFrame.ne
+   DataFrame.eq
+   DataFrame.combine
+   DataFrame.combine_first
+
+User-Defined Functions, GroupBy & Window
+----------------------------------------
+
+.. sdc_toctree
+   DataFrame.apply
+   DataFrame.applymap
+   DataFrame.pipe
+   DataFrame.agg
+   DataFrame.aggregate
+   DataFrame.transform
+   DataFrame.groupby
+   DataFrame.rolling
+   DataFrame.expanding
+   DataFrame.ewm
+
+.. _api_ref.dataframe.stats:
+
+Computations, Descriptive Statistics
+------------------------------------
+
+.. sdc_toctree
+   DataFrame.abs
+   DataFrame.all
+   DataFrame.any
+   DataFrame.clip
+   DataFrame.corr
+   DataFrame.corrwith
+   DataFrame.count
+   DataFrame.cov
+   DataFrame.cummax
+   DataFrame.cummin
+   DataFrame.cumprod
+   DataFrame.cumsum
+   DataFrame.describe
+   DataFrame.diff
+   DataFrame.eval
+   DataFrame.kurt
+   DataFrame.kurtosis
+   DataFrame.mad
+   DataFrame.max
+   DataFrame.mean
+   DataFrame.median
+   DataFrame.min
+   DataFrame.mode
+   DataFrame.pct_change
+   DataFrame.prod
+   DataFrame.product
+   DataFrame.quantile
+   DataFrame.rank
+   DataFrame.round
+   DataFrame.sem
+   DataFrame.skew
+   DataFrame.sum
+   DataFrame.std
+   DataFrame.var
+   DataFrame.nunique
+
+Re-Indexing, Selection, Label Manipulation
+------------------------------------------
+
+.. sdc_toctree
+   DataFrame.add_prefix
+   DataFrame.add_suffix
+   DataFrame.align
+   DataFrame.at_time
+   DataFrame.between_time
+   DataFrame.drop
+   DataFrame.drop_duplicates
+   DataFrame.duplicated
+   DataFrame.equals
+   DataFrame.filter
+   DataFrame.first
+   DataFrame.head
+   DataFrame.idxmax
+   DataFrame.idxmin
+   DataFrame.last
+   DataFrame.reindex
+   DataFrame.reindex_like
+   DataFrame.rename
+   DataFrame.rename_axis
+   DataFrame.reset_index
+   DataFrame.sample
+   DataFrame.set_axis
+   DataFrame.set_index
+   DataFrame.tail
+   DataFrame.take
+   DataFrame.truncate
+
+Missing Data Handling
+---------------------
+
+.. sdc_toctree
+   DataFrame.dropna
+   DataFrame.fillna
+   DataFrame.replace
+   DataFrame.interpolate
+
+Re-Shaping, Sorting, Transposing
+--------------------------------
+
+.. sdc_toctree
+   DataFrame.droplevel
+   DataFrame.pivot
+   DataFrame.pivot_table
+   DataFrame.reorder_levels
+   DataFrame.sort_values
+   DataFrame.sort_index
+   DataFrame.nlargest
+   DataFrame.nsmallest
+   DataFrame.swaplevel
+   DataFrame.stack
+   DataFrame.unstack
+   DataFrame.swapaxes
+   DataFrame.melt
+   DataFrame.explode
+   DataFrame.squeeze
+   DataFrame.to_xarray
+   DataFrame.T
+   DataFrame.transpose
+
+Combining, Joining, Merging
+-----------------------------
+
+.. sdc_toctree
+   DataFrame.append
+   DataFrame.assign
+   DataFrame.join
+   DataFrame.merge
+   DataFrame.update
+
+Time Series
+-----------
+
+.. sdc_toctree
+   DataFrame.asfreq
+   DataFrame.asof
+   DataFrame.shift
+   DataFrame.slice_shift
+   DataFrame.tshift
+   DataFrame.first_valid_index
+   DataFrame.last_valid_index
+   DataFrame.resample
+   DataFrame.to_period
+   DataFrame.to_timestamp
+   DataFrame.tz_convert
+   DataFrame.tz_localize
+
+.. _api_ref.dataframe.plotting:
+
+Plotting
+--------
+``DataFrame.plot`` is both a callable method and a namespace attribute for
+specific plotting methods of the form ``DataFrame.plot.<kind>``.
+
+.. sdc_toctree
+   DataFrame.plot
+   DataFrame.plot.area
+   DataFrame.plot.bar
+   DataFrame.plot.barh
+   DataFrame.plot.box
+   DataFrame.plot.density
+   DataFrame.plot.hexbin
+   DataFrame.plot.hist
+   DataFrame.plot.kde
+   DataFrame.plot.line
+   DataFrame.plot.pie
+   DataFrame.plot.scatter
+   DataFrame.boxplot
+   DataFrame.hist
+
+.. _api_ref.dataframe.sparse:
+
+Sparse Accessor
+---------------
+
+Sparse-``dtype`` specific methods and attributes are provided under the
+``DataFrame.sparse`` accessor.
+
+.. sdc_toctree
+   DataFrame.sparse.density
+   DataFrame.sparse.from_spmatrix
+   DataFrame.sparse.to_coo
+   DataFrame.sparse.to_dense
+
+Serialization, Input-Output, Conversion
+---------------------------------------
+
+.. sdc_toctree
+   DataFrame.from_dict
+   DataFrame.from_records
+   DataFrame.info
+   DataFrame.to_parquet
+   DataFrame.to_pickle
+   DataFrame.to_csv
+   DataFrame.to_hdf
+   DataFrame.to_sql
+   DataFrame.to_dict
+   DataFrame.to_excel
+   DataFrame.to_json
+   DataFrame.to_html
+   DataFrame.to_feather
+   DataFrame.to_latex
+   DataFrame.to_stata
+   DataFrame.to_msgpack
+   DataFrame.to_gbq
+   DataFrame.to_records
+   DataFrame.to_string
+   DataFrame.to_clipboard
+   DataFrame.style

docs/source/_templates/_api_ref.pandas.series_templ.rst

@@ -69,7 +69,7 @@ Indexing and Iteration
 For more information on ``.at``, ``.iat``, ``.loc``, and
 ``.iloc``,  see the :ref:`indexing documentation <indexing>`.
 
-Binary operator functions
+Binary Operator Functions
 -------------------------
 
 .. sdc_toctree

docs/source/apireference.rst

@@ -7,3 +7,4 @@ API Reference
    :maxdepth: 2
 
    Series: Columnar Data Structure <./_api_ref/api_ref.pandas.series.rst>
+   Dataframe: Tabular Data Structure <./_api_ref/api_ref.pandas.dataframe.rst>

docs/source/buildscripts/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# *****************************************************************************
+# Copyright (c) 2019, Intel Corporation All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#     Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *****************************************************************************