search

intake / xrviz

Interactive visualisation interface for Xarrays
https://xrviz.readthedocs.io
BSD 3-Clause "New" or "Revised" License
105 stars 21 forks source link

Improve docs #32

Closed hdsingh closed 5 years ago

hdsingh commented 5 years ago

I will improve documentation in this PR.

hdsingh commented 5 years ago

I have also added sphinx_rtd_theme (that is being used by intake docs).

hdsingh commented 5 years ago

@martindurant The API doc looks good to me now. Please have a look.

martindurant commented 5 years ago

If you haven't already, please include "numpydoc" in the extensions listed in conf.py and add it in docs/environment.yml

hdsingh commented 5 years ago

@martindurant Thanks a lot for such detailed reviews! These are really helpful for me to know more and understand the way docs should be written.

I have made changes according to the review. Please have a look.

martindurant commented 5 years ago

I went through a lot of the docstrings trying to make the text more concise. In the meantime, I may have applied some style guidelines to the code... Please review what I did in the last commit, and apply similar patterns elsewhere.

I still have reservations about exactly what happens when coordinate widgets are updated, I'll chase that up after this PR. I am finding that the xrviz interface within the intake interface is amazingly slow to set widget values, while dfviz is not, and it is essential to get to the bottom of why that might be.

hdsingh commented 5 years ago

@martindurant I made similar changes and reformat code where required. Documentation looks much better now. According to me work here is complete. Please let me know if something else needs to be changed in order to merge this PR.

martindurant commented 5 years ago

I think we may still want to circle around to this again, but I'll merge it now, as the PR has become rather long.