Documentation suite #101
Documentation suite #101
Conversation
| @@ -92,7 +92,6 @@ def display(result, view_format, delta=10, minlen=80, extend_mode=0, trunc=True, | |||
|
|
|||
|
|
|||
| def subparser(subparsers): | |||
| desc = microhapdb.cli.bubbletext + "\nRetrieve marker records by identifier or query" | |||
There was a problem hiding this comment.
Bubbletext did not render well on the sphinx autodocs. It's still shown when microhapdb -h is run, but no longer when e.g. microhapdb marker -h is run.
|
No code changes to speak of in this PR, but @rnmitchell if you have time, I'd be interested in any feedback you have on the clarity of the documentation. Thanks! |
|
Whenever I run |
|
Good catch. I need to update |
docs/ranking.md
Outdated
|
|
||
| The fixation index ($F_{ST}$) is computed on 26 global population groups. | ||
|
|
||
| The $I_n$ and F_{ST} statistics measure *between-population* allelic variation at a locus, which corresponds to the marker's utility for predicting population of origin. |
There was a problem hiding this comment.
I think this formatting of FST got messed up? Looks like it should be $F_{ST}$?
docs/targets.md
Outdated
| ## Impacted outputs | ||
|
|
||
| MicroHapDB provides several different views for marker information. | ||
| This includes the default tabular summary format, a detailed human-readable description of the marker, a view for target sequences in Fasta format, and a table of the position of each marker's SNPs. |
There was a problem hiding this comment.
This is very nitpicky but FASTA not Fasta to be correct :)
|
Good catches! Typos fixed. |
|
Thank you for your careful review! |
MicroHapDB's README has long served as a one-stop-shop for documentation. This PR adds a documentation suite (built with sphinx) that has permitted me to fill out the documentation a bit more. The new documentation includes dedicated pages for:
I've trimmed the README down a bit now that this information is included in dedicated documentation.
I'm attaching a copy of the rendered HTML docs here. Once this PR is merged, I'll configure ReadTheDocs to build and host the documentation automatically, as is done for MicroHapulator.
docs.zip