pyuvdata icon indicating copy to clipboard operation
pyuvdata copied to clipboard

Add list of methods to the top of object doc pages

Open bhazelton opened this issue 5 years ago • 2 comments

It would be nice to have a list of the methods on our primary user classes at the top of the doc pages with links to the detailed docstrings for each one. Something similar for the utility functions would be good too.

bhazelton avatar Jan 18 '20 00:01 bhazelton

This might be the right place to start: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html

bhazelton avatar Jan 18 '20 00:01 bhazelton

I've used autosummary a bit. It's nice, but it can be a little finnicky, depending on how the code is laid out. I can see if I can help with this in ~2 weeks or so.

steven-murray avatar Jan 20 '20 13:01 steven-murray