kalepy icon indicating copy to clipboard operation
kalepy copied to clipboard

readthedocs does seem to display the full API

Open matthewkenzie opened this issue 2 years ago • 1 comments

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

matthewkenzie avatar May 27 '22 12:05 matthewkenzie

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!

lzkelley avatar May 27 '22 20:05 lzkelley