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.

Sign up for GitHub

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

Jump to bottom

Add API documentation? #4

Closed
astrojuanlu opened this issue Sep 10, 2021 · 2 comments
Closed

Add API documentation? #4

astrojuanlu opened this issue Sep 10, 2021 · 2 comments

Comments

@astrojuanlu
Copy link

The documentation contains a lot of comprehensive examples, that's awesome! 🚀

I wonder if you would consider adding an API reference as well, using autodoc, autosummary, or sphinx-autoapi?
@astrojuanlu astrojuanlu mentioned this issue Sep 10, 2021
Closed
40 tasks
@athulpg007
Copy link
Owner

Added an API Reference section to docs. I was not entirely sure to make it more concise looking. I can make further changes if needed.

@astrojuanlu
Copy link
Author

Perfect! Closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@astrojuanlu @athulpg007