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

HTML API documentation #60

Open
matt-graham opened this issue Jul 8, 2021 · 2 comments
Open

HTML API documentation #60

matt-graham opened this issue Jul 8, 2021 · 2 comments

Comments

@matt-graham
Copy link

Submitting as part of JOSS review openjournals/joss-reviews#3397

Although there is API documentation in the docstrings in the code, there is no associated autogenerated HTML documentation which makes it a little difficult to browse. A nice addition would be to have autogenerated API documentation hosted on for example GitHub pages or Read the Docs.
@matt-graham matt-graham mentioned this issue Jul 8, 2021
Closed
40 tasks
@pmyteh
Copy link

pmyteh commented Jul 15, 2021

I would put this as a 'nice-to-have' rather than a blocker for acceptance. But it would be nice to have!

@matt-graham
Copy link
Author

Agreed - this is in reality more a nice-to-have than a blocker for acceptance and I should have made that clearer by not referencing it directly in the review issue - I will update the issue to reflect this.

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
@pmyteh @matt-graham