readthedocs does seem to display the full API

lzkelley / kalepy

Kernel Density Estimation and (re)sampling

Other

59 stars 12 forks source link

readthedocs does seem to display the full API #13

Open matthewkenzie opened 2 years ago

matthewkenzie commented 2 years ago

Hi, amazing package! Just noticed that the readthedocs page does not seem to display the full API of each module / class / function. E.g. this page, https://kalepy.readthedocs.io/en/latest/kalepy.html#kalepy-kde-module, is empty

lzkelley commented 2 years ago

Hi @matthewkenzie, thanks for your note. Unfortunately, these docs just haven't be written yet. At the moment, the inline docstrings (e.g. in the python code), and the included jupyter notebooks are the best way to get a sense of functionality and API interfaces. I won't be able to improve the readthedocs for a while, I don't think, but if you have any general questions/issues/suggestions/etc please feel free to post them here and I'll try to help as I can!