docs

brineylab · Mar 4, 2024 · 0b9c332 · 0b9c332
1 parent e68bc0f
commit 0b9c332
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 5 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -127,6 +127,13 @@ plotting adaptive immune receptor features like CDR3 length distributions and ge
    modules/kde
    modules/donut
 
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: io
+
+   read <read-sequences>
+   write <write-sequences>
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/source/modules/io.rst b/docs/source/modules/io.rst
@@ -0,0 +1,20 @@
+
+
+sequence IO
+====================
+
+.. _read-sequences:
+
+.. autofunction:: abutils.core.sequence.read_fasta
+.. autofunction:: abutils.core.sequence.read_airr
+.. autofunction:: abutils.core.sequence.read_csv
+.. autofunction:: abutils.core.sequence.read_json
+
+| 
+
+.. _write-sequences:
+
+.. autofunction:: abutils.core.sequence.to_fasta
+.. autofunction:: abutils.core.sequence.to_fastq
+
+
diff --git a/docs/source/modules/sequence.rst b/docs/source/modules/sequence.rst
@@ -4,9 +4,12 @@ sequence
 ===================
 
 .. autoclass:: abutils.core.sequence.Sequence
-.. autofunction:: abutils.core.sequence.read_fasta
-.. autofunction:: abutils.core.sequence.read_airr
-.. autofunction:: abutils.core.sequence.read_csv
-.. autofunction:: abutils.core.sequence.read_json
-.. autofunction:: abutils.core.sequence.to_fasta
+    :members:
 
+| 
+
+.. autofunction:: abutils.core.sequence.reverse_complement
+
+| 
+
+.. autofunction:: abutils.core.sequence.translate