Skip to content
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.

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

Create sphinx documentation (and deploy on readthedocs) #55

Open
nigelbabu opened this issue Dec 20, 2012 · 2 comments
Open

Create sphinx documentation (and deploy on readthedocs) #55

nigelbabu opened this issue Dec 20, 2012 · 2 comments

Comments

@nigelbabu
Copy link
Contributor

Document all existing features on read the docs.

@domoritz
Copy link
Contributor

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.

@rufuspollock
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants