Update the docs for new modules (#39)

* Update the docs for new modules
fulcrumgenomics · May 10, 2023 · 5ef0f5e · 5ef0f5e
1 parent 0228348
commit 5ef0f5e
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 7 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,10 +1,11 @@
-build:
-    image: latest
 version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
 sphinx:
   configuration: docs/conf.py
 python:
-    version: 3.7
     install:
     - method: pip
       path: .

diff --git a/docs/api.rst b/docs/api.rst
@@ -6,6 +6,18 @@ FGPYO
 API
 ===
 
+SAM/BAM/CRAM files
+==================
+
+.. automodule:: fgpyo.sam
+   :members:
+
+FASTA files
+===========
+
+.. automodule:: fgpyo.fasta
+   :members:
+
 Metric files
 ============
 
@@ -19,12 +31,29 @@ Metric files
    https://www.attrs.org/en/stable/examples.html
 
        The attrs website for bringing back the joy to writing classes.
-
+
+Read Structures
+===============
 
-SAM/BAM/CRAM files
-==================
+.. automodule:: fgpyo.read_structure
+   :members:
 
-.. automodule:: fgpyo.sam
+.. seealso::   
+
+   https://github.com/fulcrumgenomics/fgbio/wiki/Read-Structures
+
+       The fgbio wiki for an explanation of Read Structures.
+
+Manipulating DNA and RNA Sequences
+==================================
+
+.. automodule:: fgpyo.sequence
+   :members:
+
+Collections
+===========
+
+.. automodule:: fgpyo.c
    :members:
 
 Logging
@@ -38,3 +67,15 @@ IO
 
 .. automodule:: fgpyo.io
    :members:
+
+Utility Functions
+=================
+
+.. automodule:: fgpyo.util.inspect
+   :members:
+
+.. automodule:: fgpyo.util.string
+   :members:
+
+.. automodule:: fgpyo.util.types
+   :members: