@@ -9,6 +9,7 @@ kernelspec:
99 language : bash
1010 name : bash
1111---
12+ (sec_vcf2zarr)=
1213# vcf2zarr
1314
1415
@@ -127,3 +128,83 @@ need for small, intermediate and large datasets.
127128### Intermediate
128129
129130### Large
131+
132+ ## CLI Reference
133+
134+ % A note on cross references... There's some weird long-standing problem with
135+ % cross referencing program values in Sphinx, which means that we can't use
136+ % the built-in labels generated by sphinx-click. We can make our own explicit
137+ % targets, but these have to have slightly weird names to avoid conflicting
138+ % with what sphinx-click is doing. So, hence the cmd- prefix.
139+ % Based on: https://github.com/skypilot-org/skypilot/pull/2834
140+
141+ <!-- .. _cmd-vcf2zarr: -->
142+ <!-- .. click:: bio2zarr.cli:vcf2zarr_main -->
143+ <!-- :prog: vcf2zarr -->
144+ <!-- :nested: short -->
145+
146+ ``` {eval-rst}
147+
148+ .. _cmd-vcf2zarr-convert:
149+ .. click:: bio2zarr.cli:convert_vcf
150+ :prog: vcf2zarr convert
151+ :nested: full
152+
153+ .. _cmd-vcf2zarr-inspect:
154+ .. click:: bio2zarr.cli:inspect
155+ :prog: vcf2zarr inspect
156+ :nested: full
157+
158+ .. _cmd-vcf2zarr-mkschema:
159+ .. click:: bio2zarr.cli:mkschema
160+ :prog: vcf2zarr mkschema
161+ :nested: full
162+ ```
163+
164+ ### Explode
165+
166+ ``` {eval-rst}
167+ .. _cmd-vcf2zarr-explode:
168+ .. click:: bio2zarr.cli:explode
169+ :prog: vcf2zarr explode
170+ :nested: full
171+
172+ .. _cmd-vcf2zarr-dexplode-init:
173+ .. click:: bio2zarr.cli:dexplode_init
174+ :prog: vcf2zarr dexplode-init
175+ :nested: full
176+
177+ .. _cmd-vcf2zarr-dexplode-partition:
178+ .. click:: bio2zarr.cli:dexplode_partition
179+ :prog: vcf2zarr dexplode-partition
180+ :nested: full
181+
182+ .. _cmd-vcf2zarr-dexplode-finalise:
183+ .. click:: bio2zarr.cli:dexplode_finalise
184+ :prog: vcf2zarr dexplode-finalise
185+ :nested: full
186+ ```
187+
188+ ### Encode
189+
190+ ``` {eval-rst}
191+ .. click:: bio2zarr.cli:encode
192+ :prog: vcf2zarr encode
193+ :nested: full
194+
195+ .. _cmd-vcf2zarr-dencode-init:
196+ .. click:: bio2zarr.cli:dencode_init
197+ :prog: vcf2zarr dencode-init
198+ :nested: full
199+
200+ .. _cmd-vcf2zarr-dencode-partition:
201+ .. click:: bio2zarr.cli:dencode_partition
202+ :prog: vcf2zarr dencode-partition
203+ :nested: full
204+
205+ .. _cmd-vcf2zarr-dencode-finalise:
206+ .. click:: bio2zarr.cli:dencode_finalise
207+ :prog: vcf2zarr dencode-finalise
208+ :nested: full
209+ ```
210+
0 commit comments