search

tkchafin / autostreamtree

Stream trees for SNP datasets
GNU General Public License v3.0
1 stars 0 forks source link

[JOSS Review] Publish the package docs as ReadTheDocs #8

Closed abhishektiwari closed 8 months ago

abhishektiwari commented 9 months ago

Firstly, I find it really hard to browse the PDF package doc generated by pandoc. Secondly, PDF docs are not automatically generated for every version. So for instance, current version of autostreamtree is v1.1.3 but PDF doc was generated on back of v1.1.0.

I strongly suggest to publish the package docs as Read The Docs. Once project created you can use webhooks to update the docs to latest version.

JOSS Review

tkchafin commented 9 months ago

Thanks, that's a good idea, I'll look into that and see about tying it in to the existing CI/CD workflow

tkchafin commented 8 months ago

I've integrated the documentation build as HTML into the CI workflow, which will update on each commit. Documentation will be viewable at: https://tkchafin.github.io/autostreamtree/ Also adding a note with the link to the README