search

NEXTBioinformatics / Best-Practices-for-Processing-HTS-Data

3 stars 2 forks source link

Document Format #1

Closed micknudsen closed 7 years ago

micknudsen commented 7 years ago

Since the document will contain lots and lots of code and command line arguments, maybe we should consider a different format than LaTeX?

How about something like Read the Docs (RTD)? If you are not familiar with RTD, have a look at the CNVkit repository (we use this tool at MOMA). The documentation is written in RTD.

To me, it seems that RTD (or something similar) is the ideal framework for structuring a Best Practices document.

rfbrondum commented 7 years ago

I am open for switching the format, and the layout of RTD seems quite good, so if it is an easy switch I have no problem.

mboegsted commented 7 years ago

Seems like a good idea, please go ahead!

micknudsen commented 7 years ago

I have now completed the transition to Read the Docs (but not added content back yet). Does it work for all of you? Clicking the 'docs' badge in the README file hopefully takes you to a beautifully rendered version of the docs. It will be updated automatically each time a new version is pushed to GitHub.

It is possible to build the pages locally by simply running 'make html', but you may have to install some Python dependencies first.

rfbrondum commented 7 years ago

Great work, the docs button works just fine here!