Docs updates (incomplete)

[jelmelk]

Just a starting point. Leave feedback/comments/complaints

[ocefpaf]

We should not copy the docstring here. We can (and should) build a detailed API docs based on the docstrings automatically.

This part should be simple examples only.

[jelmelk]

I did have it more detailed, but I wasn't sure what was the preferred method (consistency reasons). I have ideas for that.

[ocefpaf]

My imagine the index.rst as quick intro.

Later on we can add more, like a typical automodule in the fashion:

$ cat folium.rst

:mod:`folium`
--------------

.. automodule:: foium.folium
    :members:
    :undoc-members:
    :show-inheritance:

Same for map.py, features.py, etc. But before that we need to review the docstrings too.

[jilljenn]

Is it for this reason that the autoclass commands do not provide currently any documentation in http://folium.readthedocs.org/en/latest/module/features.html#polyline?

[ocefpaf]

@jelmelk This is looking good. Thanks for doing this! I made a few comments, but there is still a long way to go. (Not your fault. We neglected the docs for way too long!)

I would like to invite more people to read this too @python-visualization/folium 😉

[ocefpaf]

@jelmelk are you still interested in finishing this PR? If not let me know so I can try to pick your changes and issue a new one.

[ocefpaf]

Closing this b/c it seems that @jelmelk is no longer available to finish it.
We can re-open if someone else is interested into this.