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

Documentation #56

Open
cooperlab opened this issue Feb 2, 2022 · 3 comments
Open

Documentation #56

cooperlab opened this issue Feb 2, 2022 · 3 comments
Assignees
@cooperlab @Leengit

Comments

@cooperlab
Copy link
Collaborator

Provide basic documentation on the intent, installation, and utilization of the package. Document the fields and data structures produced by histomics stream.
@cooperlab cooperlab self-assigned this Feb 2, 2022
@thewtex
Copy link
Collaborator

thewtex commented Apr 11, 2022

+1 for Sphinx / ReadTheDoc's

@Leengit
Copy link
Collaborator

Leengit commented Apr 27, 2022

@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?

@thewtex
Copy link
Collaborator

thewtex commented May 3, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cooperlab cooperlab

@Leengit Leengit

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@thewtex @cooperlab @Leengit