The Sphinx documentation needs restructuring and updating to reflect bcftbx becoming essentially a toolbox library, and specifically for changes happening as part the refactoring of the library to address issue #33.
Suggested updates:
- Focus should switch to acting as a reference for the library
- "Background" sections for SOLiD and Illumina data should be retained
- Add explanation of the changes from legacy to new structure (with aim being to deprecate the legacy code in future)
The README also needs updating.
The Sphinx documentation needs restructuring and updating to reflect
bcftbxbecoming essentially a toolbox library, and specifically for changes happening as part the refactoring of the library to address issue #33.Suggested updates:
The
READMEalso needs updating.