easyaccess icon indicating copy to clipboard operation
easyaccess copied to clipboard

Consider creating narrative documentation for easyaccess

Open ngoldbaum opened this issue 7 years ago • 2 comments

Some of the usage example movies in the presentation describing easyaccess are a little hard to follow. In addition, it's a little awkward to search a presentation for information and probably also not straightfoward to add new content to.

You may want to consider creating a set of sphinx documentation for easyaccess, which you could then deploy for free on readthedocs or github pages. This will produce a set of HTML documentation that might be a bit easier for your users to interact with. It would also be a good place to migrate content from the DES confluence to a public space if you care at all about that.

ngoldbaum avatar Nov 15 '18 17:11 ngoldbaum

Thanks, it's been on my TODO for some time, the presentation grew to be more than I originally planned

mgckind avatar Nov 15 '18 19:11 mgckind

I've going to update the current page, but want to leave this open to eventually also move to readthedocs including the docstrings from the methods inside the code, Thanks!

mgckind avatar Jan 14 '19 18:01 mgckind