uab-cgds-worthey / quac

🦆 Quality Control of WGS and exome samples 🦆
https://quac.readthedocs.io
GNU General Public License v3.0
5 stars 1 forks source link

Restructure docs and host using ReadTheDocs #61

Closed ManavalanG closed 1 year ago

ManavalanG commented 1 year ago

Pull request

Please fill in the checklist below and comment as needed.

Anything else reviewer should know?

Main goal of this PR is to restructure the docs to make it clearer to non-Cheaha users, update documentation to reflect recent CLI option changes, and host docs publicly using readthedocs. QuaC doc is now available at https://quac.readthedocs.io/, which is based on the branch in this PR.

ManavalanG commented 1 year ago

@wilkb777 Ready for your review again.

Note: Github markdown-link-check actions still fails with this public link - https://gatk.broadinstitute.org/hc/en-us/articles/360035531972-PED-Pedigree-format. Not sure why.

ManavalanG commented 1 year ago

@wilkb777 Updated docs to make it clear that quac is built to use with human data.