Skip to content
Snippets Groups Projects
Commit e7e10c0d authored by Bert Palm's avatar Bert Palm 🎇
Browse files

add stuff for sphinx

parent 0665773c
No related branches found
No related tags found
No related merge requests found
Showing
with 394 additions and 0 deletions
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Ignore everything
*
# But not these files...
!.gitignore
\ No newline at end of file
CastPolicy
==========
.. currentmodule:: dios
.. autoclass:: CastPolicy
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~CastPolicy.force
~CastPolicy.never
~CastPolicy.save
.. rubric:: Attributes Documentation
.. autoattribute:: force
.. autoattribute:: never
.. autoattribute:: save
DictOfSeries
============
.. currentmodule:: dios
.. autoclass:: DictOfSeries
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~DictOfSeries.aloc
~DictOfSeries.at
~DictOfSeries.cast_policy
~DictOfSeries.columns
~DictOfSeries.debugDf
~DictOfSeries.dtypes
~DictOfSeries.empty
~DictOfSeries.iat
~DictOfSeries.iloc
~DictOfSeries.indexes
~DictOfSeries.itype
~DictOfSeries.lengths
~DictOfSeries.loc
~DictOfSeries.size
~DictOfSeries.values
.. rubric:: Methods Summary
.. autosummary::
~DictOfSeries.all
~DictOfSeries.any
~DictOfSeries.apply
~DictOfSeries.astype
~DictOfSeries.clear
~DictOfSeries.copy
~DictOfSeries.copy_empty
~DictOfSeries.dropempty
~DictOfSeries.dropna
~DictOfSeries.equals
~DictOfSeries.for_each
~DictOfSeries.get
~DictOfSeries.hasnans
~DictOfSeries.index_of
~DictOfSeries.isdata
~DictOfSeries.isempty
~DictOfSeries.isin
~DictOfSeries.isna
~DictOfSeries.isnull
~DictOfSeries.items
~DictOfSeries.iteritems
~DictOfSeries.iterrows
~DictOfSeries.keys
~DictOfSeries.max
~DictOfSeries.memory_usage
~DictOfSeries.min
~DictOfSeries.notempty
~DictOfSeries.notna
~DictOfSeries.notnull
~DictOfSeries.pop
~DictOfSeries.popitem
~DictOfSeries.reduce_columns
~DictOfSeries.setdefault
~DictOfSeries.squeeze
~DictOfSeries.to_csv
~DictOfSeries.to_df
~DictOfSeries.to_string
~DictOfSeries.update
.. rubric:: Attributes Documentation
.. autoattribute:: aloc
.. autoattribute:: at
.. autoattribute:: cast_policy
.. autoattribute:: columns
.. autoattribute:: debugDf
.. autoattribute:: dtypes
.. autoattribute:: empty
.. autoattribute:: iat
.. autoattribute:: iloc
.. autoattribute:: indexes
.. autoattribute:: itype
.. autoattribute:: lengths
.. autoattribute:: loc
.. autoattribute:: size
.. autoattribute:: values
.. rubric:: Methods Documentation
.. automethod:: all
.. automethod:: any
.. automethod:: apply
.. automethod:: astype
.. automethod:: clear
.. automethod:: copy
.. automethod:: copy_empty
.. automethod:: dropempty
.. automethod:: dropna
.. automethod:: equals
.. automethod:: for_each
.. automethod:: get
.. automethod:: hasnans
.. automethod:: index_of
.. automethod:: isdata
.. automethod:: isempty
.. automethod:: isin
.. automethod:: isna
.. automethod:: isnull
.. automethod:: items
.. automethod:: iteritems
.. automethod:: iterrows
.. automethod:: keys
.. automethod:: max
.. automethod:: memory_usage
.. automethod:: min
.. automethod:: notempty
.. automethod:: notna
.. automethod:: notnull
.. automethod:: pop
.. automethod:: popitem
.. automethod:: reduce_columns
.. automethod:: setdefault
.. automethod:: squeeze
.. automethod:: to_csv
.. automethod:: to_df
.. automethod:: to_string
.. automethod:: update
DtItype
=======
.. currentmodule:: dios
.. autoclass:: DtItype
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~DtItype.min_pdindex
~DtItype.name
~DtItype.subtypes
~DtItype.unique
.. rubric:: Attributes Documentation
.. autoattribute:: min_pdindex
.. autoattribute:: name
.. autoattribute:: subtypes
.. autoattribute:: unique
FloatItype
==========
.. currentmodule:: dios
.. autoclass:: FloatItype
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FloatItype.min_pdindex
~FloatItype.name
~FloatItype.subtypes
~FloatItype.unique
.. rubric:: Attributes Documentation
.. autoattribute:: min_pdindex
.. autoattribute:: name
.. autoattribute:: subtypes
.. autoattribute:: unique
IntItype
========
.. currentmodule:: dios
.. autoclass:: IntItype
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~IntItype.min_pdindex
~IntItype.name
~IntItype.subtypes
~IntItype.unique
.. rubric:: Attributes Documentation
.. autoattribute:: min_pdindex
.. autoattribute:: name
.. autoattribute:: subtypes
.. autoattribute:: unique
ItypeCastError
==============
.. currentmodule:: dios
.. autoexception:: ItypeCastError
ItypeCastWarning
================
.. currentmodule:: dios
.. autoexception:: ItypeCastWarning
ItypeWarning
============
.. currentmodule:: dios
.. autoexception:: ItypeWarning
NumItype
========
.. currentmodule:: dios
.. autoclass:: NumItype
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~NumItype.min_pdindex
~NumItype.name
~NumItype.subtypes
~NumItype.unique
.. rubric:: Attributes Documentation
.. autoattribute:: min_pdindex
.. autoattribute:: name
.. autoattribute:: subtypes
.. autoattribute:: unique
ObjItype
========
.. currentmodule:: dios
.. autoclass:: ObjItype
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~ObjItype.min_pdindex
~ObjItype.name
~ObjItype.subtypes
~ObjItype.unique
.. rubric:: Attributes Documentation
.. autoattribute:: min_pdindex
.. autoattribute:: name
.. autoattribute:: subtypes
.. autoattribute:: unique
Opts
====
.. currentmodule:: dios
.. autoclass:: Opts
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~Opts.itype_err
~Opts.itype_ignore
~Opts.itype_warn
~Opts.repr_aligned
~Opts.repr_indexed
.. rubric:: Attributes Documentation
.. autoattribute:: itype_err
.. autoattribute:: itype_ignore
.. autoattribute:: itype_warn
.. autoattribute:: repr_aligned
.. autoattribute:: repr_indexed
OptsFields
==========
.. currentmodule:: dios
.. autoclass:: OptsFields
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~OptsFields.dios_repr
~OptsFields.disp_max_cols
~OptsFields.disp_max_rows
~OptsFields.disp_min_rows
~OptsFields.mixed_itype_warn_policy
.. rubric:: Attributes Documentation
.. autoattribute:: dios_repr
.. autoattribute:: disp_max_cols
.. autoattribute:: disp_max_rows
.. autoattribute:: disp_min_rows
.. autoattribute:: mixed_itype_warn_policy
cast_to_itype
=============
.. currentmodule:: dios
.. autofunction:: cast_to_itype
dios_options
============
.. currentmodule:: dios
.. autodata:: dios_options
get_itype
=========
.. currentmodule:: dios
.. autofunction:: get_itype
is_itype
========
.. currentmodule:: dios
.. autofunction:: is_itype
is_itype_like
=============
.. currentmodule:: dios
.. autofunction:: is_itype_like
is_itype_subtype
================
.. currentmodule:: dios
.. autofunction:: is_itype_subtype
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment