HTML API documentation - Githubissues

mggg / ecological-inference

Ecological inference, in Python

MIT License

28 stars 11 forks source link

HTML API documentation #60

Open matt-graham opened 3 years ago

matt-graham commented 3 years ago

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.

pmyteh commented 3 years ago

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

matt-graham commented 3 years ago

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.