Merge pull request #235 from jeromekelleher/doc-updates

Add todo item for copying to object stores

Author: jeromekelleher

docs/_config.yml

@@ -25,9 +25,11 @@ html:
 sphinx:
   extra_extensions:
     - sphinx_click.ext
+    - sphinx.ext.todo
   config:
     # This is needed to make sure that text is output in single block from
     # bash cells.
     nb_merge_streams: true
+    todo_include_todos: true
     myst_enable_extensions:
       - colon_fence

docs/vcf2zarr/overview.md

@@ -20,6 +20,7 @@ FINISH ME
 :::
 
 
+
 ## How does it work?
 The conversion of VCF data to Zarr is a two-step process:
 
@@ -122,3 +123,11 @@ to encode allows you to try out these options on small subsets, hopefully
 arriving at settings with the desired balance of compression and query
 performance.
 
+
+## Copying to object stores
+
+:::{todo}
+Document process of copying VCF Zarr datasets to an object store like S3.
+See [Issue 234](https://github.com/sgkit-dev/bio2zarr/issues/234)
+:::
+