.. param_types documentation master file, created by
   sphinx-quickstart on Tue Jan  9 02:18:04 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to param_types's documentation!
=======================================

Cross-reference results were generated using, the aliases dictionary
below.

.. code-block:: python

    numpydoc_xref_aliases = {
        # python
        'sequence': ':term:`python:sequence`',
        'iterable': ':term:`python:iterable`',
        'class': ':term:`python:class`',
        'lambda': ':term:`python:lambda`',
        'file-like': ':term:`file-like<python:file-like object>`',
        'file_like': ':term:`file_like<python:file-like object>`',
        'string': 'str',
        'strings': 'str',
        'dictionary': 'dict',
        'dictionaries': 'dict',
        'tuples': 'tuple',
        'boolean': 'bool',
        'integer': 'int',
        'integers': 'int',
        'Integer': 'int',
        'ints': 'int',
        'floats': 'float',
        'double': 'float',
        # numpy
        'array': 'numpy.ndarray',
        'dtype': 'numpy.dtype',
        'ndarray': 'numpy.ndarray',
        'matrix': 'numpy.matrix',
        'MaskedArray': 'numpy.ma.MaskedArray',
        'array-like': ':term:`array-like<numpy:array_like>`',
        'array_like': ':term:`numpy:array_like`',
        # scipy
        'sparse': 'scipy.sparse.spmatrix',
        # pandas
        'dataframe': 'pandas.DataFrame',
        'DataFrame': 'pandas.DataFrame',
        'Series': 'pandas.Series',
        'series': 'pandas.Series',
    }


.. toctree::
   :maxdepth: 2
   :glob:
   :caption: Contents:

   *-param-types



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`