dataconverters icon indicating copy to clipboard operation
dataconverters copied to clipboard

Create sphinx documentation (and deploy on readthedocs)

Open nigelbabu opened this issue 11 years ago • 2 comments

Document all existing features on read the docs.

nigelbabu avatar Dec 20 '12 13:12 nigelbabu

I would be interested in learning more about the arguments that can be passed to dataconverter. Is there any reason why I have to pass a dictionary instead of just python arguments?

You could have something like dataconverter(file, type=None, target=None, header_type=None). You could even convert arbitrary arguments to a dict, if you prefer.

domoritz avatar Dec 21 '12 10:12 domoritz

IMO: just document in the README.rst and in docstrings. sphinx docs can come later ;-)

rufuspollock avatar Dec 22 '12 10:12 rufuspollock