humburg / pirates

Improving the quality of deep sequencing data
MIT License
0 stars 0 forks source link

Add documentation #13

Open humburg opened 7 years ago

humburg commented 7 years ago

Add documentation for modules, classes and functions using a standard format. I would suggest using Google style docstrings for processing with napoleon and sphinx with documentation published on Read the Docs.

This will require setting up the infrastructure to compile and publish the documentation as well as adding some guidelines to CONTRIBUTING.