Document Python API for VCF

Closes #364

Author: jeromekelleher

bio2zarr/vcf.py

@@ -1608,7 +1608,7 @@ def mkschema(
 
 def convert(
     vcfs,
-    out_path,
+    vcz_path,
     *,
     variants_chunk_size=None,
     samples_chunk_size=None,
@@ -1617,6 +1617,12 @@ def convert(
     show_progress=False,
     icf_path=None,
 ):
+    """
+    Convert the VCF data at the specified list of paths
+    to VCF Zarr format stored at the specified path.
+
+    .. todo:: Document parameters
+    """
     if icf_path is None:
         cm = temp_icf_path(prefix="vcf2zarr")
     else:
@@ -1631,7 +1637,7 @@ def convert(
         )
         encode(
             icf_path,
-            out_path,
+            vcz_path,
             variants_chunk_size=variants_chunk_size,
             samples_chunk_size=samples_chunk_size,
             worker_processes=worker_processes,

docs/_toc.yml

@@ -6,6 +6,7 @@ chapters:
   sections:
   - file: vcf2zarr/tutorial
   - file: vcf2zarr/cli_ref
+  - file: vcf2zarr/python_api
 - file: plink2zarr/overview
   sections:
   - file: plink2zarr/cli_ref

docs/vcf2zarr/python_api.md

@@ -0,0 +1,17 @@
+(sec-vcf2zarr-python-api)=
+# Python API
+
+Basic usage:
+```python
+import bio2zarr.vcf as v2z
+
+v2z.convert([vcf_path], vcz_path)
+```
+
+## API reference
+
+```{eval-rst}
+
+.. autofunction:: bio2zarr.vcf.convert
+
+```