Skip to content

Commit 8771e7c

Browse files
Get basic cross-referencing working + logical grouping
1 parent 25b275f commit 8771e7c

File tree

2 files changed

+73
-6
lines changed

2 files changed

+73
-6
lines changed

docs/cli.md

Lines changed: 72 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,77 @@
11
# Command Line Interface
22

3+
% A note on cross references... There's some weird long-standing problem with
4+
% cross referencing program values in Sphinx, which means that we can't use
5+
% the built-in labels generated by sphinx-click. We can make our own explicit
6+
% targets, but these have to have slightly weird names to avoid conflicting
7+
% with what sphinx-click is doing. So, hence the cmd- prefix.
8+
% Based on: https://github.com/skypilot-org/skypilot/pull/2834
9+
310
```{eval-rst}
11+
.. _cmd-vcf2zarr:
412
.. click:: bio2zarr.cli:vcf2zarr
5-
:prog: vcf2zarr
6-
:show-nested:
13+
:prog: vcf2zarr
14+
:nested: short
15+
16+
.. _cmd-vcf2zarr-convert:
17+
.. click:: bio2zarr.cli:convert_vcf
18+
:prog: vcf2zarr convert
19+
:nested: full
20+
21+
.. _cmd-vcf2zarr-inspect:
22+
.. click:: bio2zarr.cli:inspect
23+
:prog: vcf2zarr inspect
24+
:nested: full
25+
26+
.. _cmd-vcf2zarr-mkschema:
27+
.. click:: bio2zarr.cli:mkschema
28+
:prog: vcf2zarr mkschema
29+
:nested: full
30+
```
31+
32+
## Explode
33+
34+
```{eval-rst}
35+
.. click:: bio2zarr.cli:explode
36+
:prog: vcf2zarr explode
37+
:nested: full
38+
39+
.. _cmd-vcf2zarr-dexplode-init:
40+
.. click:: bio2zarr.cli:dexplode_init
41+
:prog: vcf2zarr dexplode-init
42+
:nested: full
43+
44+
.. _cmd-vcf2zarr-dexplode-partition:
45+
.. click:: bio2zarr.cli:dexplode_partition
46+
:prog: vcf2zarr dexplode-partition
47+
:nested: full
48+
49+
.. _cmd-vcf2zarr-dexplode-finalise:
50+
.. click:: bio2zarr.cli:dexplode_finalise
51+
:prog: vcf2zarr dexplode-finalise
52+
:nested: full
53+
```
54+
55+
## Encode
56+
57+
```{eval-rst}
58+
.. click:: bio2zarr.cli:encode
59+
:prog: vcf2zarr encode
60+
:nested: full
61+
62+
.. _cmd-vcf2zarr-dencode-init:
63+
.. click:: bio2zarr.cli:dencode_init
64+
:prog: vcf2zarr dencode-init
65+
:nested: full
66+
67+
.. _cmd-vcf2zarr-dencode-partition:
68+
.. click:: bio2zarr.cli:dencode_partition
69+
:prog: vcf2zarr dencode-partition
70+
:nested: full
71+
72+
.. _cmd-vcf2zarr-dencode-finalise:
73+
.. click:: bio2zarr.cli:dencode_finalise
74+
:prog: vcf2zarr dencode-finalise
75+
:nested: full
76+
```
777

8-
.. click:: bio2zarr.cli:plink2zarr
9-
:prog: plink2zarr
10-
:show-nested:

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ and will always work.
3131

3232
## Basic vcf2zarr usage
3333
For modest VCF files (up to a few GB), a single command can be used to convert a VCF file
34-
(or set of VCF files) to Zarr:
34+
(or set of VCF files) using the {ref}`convert<cmd-vcf2zarr-convert>` command:
3535

3636
```bash
3737
$ vcf2zarr convert <VCF1> <VCF2> ... <VCFN> <zarr>

0 commit comments

Comments
 (0)