pandas-datareader

pandas-datareader copied to clipboard

Current documentation is not clear. Shall I start improving it? Who is the maintainer for this? Doc string inside the code is much clear than the documentation.

Documentation improvement and examples are always welcome.

Apidocs would display the docstrings as Sphinx HTML with 'view source' links.

The (undocumented) -M option to apidoc puts the top-level module documentation first: https://bitbucket.org/birkenfeld/sphinx/pull-requests/236/1456-apidoc-add-a-m-option-to-put-module/diff

Module docs could be moved to the top-level docstrings?

Doctest format could be helpful for maintenance.

The IPython %doctest command changes the prompt so that tests cases and examples with input and output can be copied to docstrings (and potentially also tested along with the rest of the build)

Jupyter notebook output cells can also be tested with e.g a pytest plugin; and/or copied into Sphinx docs.

https://github.com/computationalmodelling/nbval

http://nbsphinx.readthedocs.io/en/latest/

• A. currently: copied & pasted into remote_data.rst
• B. Module docstrings and apidoc
• C. Doctests in the module docstring
• D. Jupyter notebook(s) + nbval + nbsphinx

@westurner maybe you could offer a prototype PR?