HistomicsStream icon indicating copy to clipboard operation
HistomicsStream copied to clipboard
verified publisher icon DigitalSlideArchive

Documentation

Open cooperlab opened this issue 4 years ago • 3 comments

Provide basic documentation on the intent, installation, and utilization of the package. Document the fields and data structures produced by histomics stream.

cooperlab avatar Feb 02 '22 18:02 cooperlab

+1 for Sphinx / ReadTheDoc's

thewtex avatar Apr 11 '22 17:04 thewtex

@thewtex Sphinx offers quite a bit of functionality and I am unsure how to prioritize. Can you recommend a project similar enough to HistomicsStream in scope that is already using Sphinx and would make a good template?

Leengit avatar Apr 27 '22 14:04 Leengit

Hi @Leengit , there are many examples, prehaps xarray-datatree. ReadTheDocs simplifies deployment. They say they have 80,000 open source project examples, too :-).

thewtex avatar May 03 '22 19:05 thewtex