Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readthedocs does seem to display the full API #13

Open
matthewkenzie opened this issue May 27, 2022 · 1 comment
Open

readthedocs does seem to display the full API #13

matthewkenzie opened this issue May 27, 2022 · 1 comment
Assignees
Labels
question Further information is requested

Comments

@matthewkenzie
Copy link

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
Copy link
Owner

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 lzkelley self-assigned this May 27, 2022
@lzkelley lzkelley added the question Further information is requested label May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants